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 01/60] Change namespace layout slightly --- src/layouts/api-namespace.hbs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-namespace.hbs b/src/layouts/api-namespace.hbs index 49d72cada..6a180bf4f 100644 --- a/src/layouts/api-namespace.hbs +++ b/src/layouts/api-namespace.hbs @@ -2,12 +2,14 @@ description: {{description}} --- -# {{title}} +# The {{title}} Namespace {{overview}} ## Resources +The {{title}} namespace contains the following resources: + {{#each resources}} ### [`{{name}}`]({{link}}) {{description}} From 0b2e0afa9ead1881637ff351971138587689a8e9 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 17:58:42 +0000 Subject: [PATCH 02/60] ci: Generate docs --- docs/api/acs/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 4767e017d..3b0a758e2 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems +# The Access Control Systems Namespace Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,6 +21,8 @@ To grant access using the Seam access control system API, use the following basi ## Resources +The Access Control Systems namespace contains the following resources: + ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From 5e61d46d12ae6c7ba80562ffae196686443759fc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:01:49 -0400 Subject: [PATCH 03/60] Update api-namespace.hbs --- src/layouts/api-namespace.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-namespace.hbs b/src/layouts/api-namespace.hbs index 6a180bf4f..16e7e1147 100644 --- a/src/layouts/api-namespace.hbs +++ b/src/layouts/api-namespace.hbs @@ -2,7 +2,7 @@ description: {{description}} --- -# The {{title}} Namespace +# {{title}} {{overview}} From 03d7d3353c09662894b618d765292fdfa08b2162 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:03:13 +0000 Subject: [PATCH 04/60] ci: Generate docs --- docs/api/acs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 3b0a758e2..8aaecca62 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# The Access Control Systems Namespace +# Access Control Systems Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 064022d0a5bfdc77224e58b68ac7b9303902f635 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:05:57 -0400 Subject: [PATCH 05/60] Update api-route.hbs --- src/layouts/api-route.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 5274b67df..7a9c877c9 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -1,5 +1,7 @@ # {{title}} +The {{title}} route contains the following resources: + {{#each resources}} {{> api-resource this}} {{#if errors.length}} From 888505a8faeff9ea499f319221d666a6e703090b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:06:59 +0000 Subject: [PATCH 06/60] ci: Generate docs --- docs/api/acs/access_groups/README.md | 2 ++ docs/api/acs/credentials/README.md | 2 ++ docs/api/acs/encoders/README.md | 2 ++ docs/api/acs/encoders/simulate/README.md | 2 ++ docs/api/acs/entrances/README.md | 2 ++ docs/api/acs/systems/README.md | 2 ++ docs/api/acs/users/README.md | 2 ++ docs/api/phones/README.md | 2 ++ docs/api/phones/simulate/README.md | 2 ++ docs/api/thermostats/README.md | 2 ++ docs/api/thermostats/schedules/README.md | 2 ++ docs/api/thermostats/simulate/README.md | 2 ++ docs/api/user_identities/README.md | 2 ++ docs/api/user_identities/enrollment_automations/README.md | 2 ++ 14 files changed, 28 insertions(+) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index afbc61aa0..09867517e 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -1,5 +1,7 @@ # Access Groups +The Access Groups route contains the following resources: + ## `acs_access_group` Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 564bcd036..236193c90 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -1,5 +1,7 @@ # Credentials +The Credentials route contains the following resources: + ## `acs_credential` Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index c1e2997f2..7f49da5a8 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -1,5 +1,7 @@ # Encoders +The Encoders route contains the following resources: + ## `acs_encoder` Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index adf033739..903e4e935 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -1,5 +1,7 @@ # Encoder Simulations +The Encoder Simulations route contains the following resources: + ## Endpoints ### [`/acs/encoders/simulate/next_credential_encode_will_fail`](./next_credential_encode_will_fail.md) diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 026a4352c..ce0feedd4 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -1,5 +1,7 @@ # Entrances +The Entrances route contains the following resources: + ## `acs_entrance` Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 240f75036..b5359816b 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -1,5 +1,7 @@ # Systems +The Systems route contains the following resources: + ## `acs_system` Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 248661f43..4a04b38cb 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -1,5 +1,7 @@ # ACS Users +The ACS Users route contains the following resources: + ## `acs_user` Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 3028245cb..350b97e41 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -1,5 +1,7 @@ # Phones +The Phones route contains the following resources: + ## `phone` Represents an app user's mobile phone. diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index e361df769..0e26ab5a1 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -1,5 +1,7 @@ # Phone Simulations +The Phone Simulations route contains the following resources: + ## Endpoints ### [`/phones/simulate/create_sandbox_phone`](./create_sandbox_phone.md) diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 66d5e32cc..fca49b1bc 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -1,5 +1,7 @@ # Thermostats +The Thermostats route contains the following resources: + ## Endpoints ### [`/thermostats/activate_climate_preset`](./activate_climate_preset.md) diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 48b777e4f..794091e4b 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -1,5 +1,7 @@ # Thermostat Schedules +The Thermostat Schedules route contains the following resources: + ## `thermostat_schedule` Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 55ddf5a83..51f7e82e7 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -1,5 +1,7 @@ # Thermostat Simulations +The Thermostat Simulations route contains the following resources: + ## Endpoints ### [`/thermostats/simulate/hvac_mode_adjusted`](./hvac_mode_adjusted.md) diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 1ef7a3ddf..602814b4b 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -1,5 +1,7 @@ # User Identities +The User Identities route contains the following resources: + ## `user_identity` Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index f27a87236..890683324 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -1,5 +1,7 @@ # Enrollment Automations +The Enrollment Automations route contains the following resources: + ## `enrollment_automation` Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). From e2b0275e439e5ec3da0df497dbf7acaaa4a9e807 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:08:34 -0400 Subject: [PATCH 07/60] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 86205b416..8897755d3 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -1,13 +1,19 @@ {{#if headingOffset}} -### `{{name}}` +### The `{{name}}` Resource {{else}} -## `{{name}}` +## The `{{name}}` Resource {{/if}} {{#if description}} {{description}} {{/if}} +{{#if headingOffset}} +#### Properties +{{else}} +## Properties +{{/if}} + {{#each properties}} {{#if ../headingOffset}} #### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} From b40e4ed938b488e715071098aa1d5cb7c1c021ae Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:09:33 +0000 Subject: [PATCH 08/60] ci: Generate docs --- docs/api/acs/access_groups/README.md | 4 +++- docs/api/acs/credentials/README.md | 4 +++- docs/api/acs/encoders/README.md | 4 +++- docs/api/acs/encoders/encode_credential.md | 4 +++- docs/api/acs/encoders/scan_credential.md | 4 +++- docs/api/acs/entrances/README.md | 4 +++- docs/api/acs/systems/README.md | 4 +++- docs/api/acs/users/README.md | 4 +++- docs/api/phones/README.md | 4 +++- docs/api/thermostats/activate_climate_preset.md | 4 +++- docs/api/thermostats/cool.md | 4 +++- docs/api/thermostats/heat.md | 4 +++- docs/api/thermostats/heat_cool.md | 4 +++- docs/api/thermostats/off.md | 4 +++- docs/api/thermostats/schedules/README.md | 4 +++- docs/api/thermostats/set_fan_mode.md | 4 +++- docs/api/thermostats/set_hvac_mode.md | 4 +++- docs/api/user_identities/README.md | 4 +++- docs/api/user_identities/enrollment_automations/README.md | 4 +++- 19 files changed, 57 insertions(+), 19 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 09867517e..b03ebddae 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -2,11 +2,13 @@ The Access Groups route contains the following resources: -## `acs_access_group` +## The `acs_access_group` Resource Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `access_group_type` {% hint style="warning" %} diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 236193c90..18756514c 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -2,10 +2,12 @@ The Credentials route contains the following resources: -## `acs_credential` +## The `acs_credential` Resource Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. +## Properties + ### `access_method` Format: `Enum` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 7f49da5a8..90948c79d 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -2,10 +2,12 @@ The Encoders route contains the following resources: -## `acs_encoder` +## The `acs_encoder` Resource Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +## Properties + ### `acs_encoder_id` Format: `UUID` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 4ff61ba93..36a2096f1 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -36,10 +36,12 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. [action\_attempt](./) -### `ENCODE_CREDENTIAL` +### The `ENCODE_CREDENTIAL` Resource Encoding credential data from physical encoder. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index cbe3e050d..91078e1d8 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -27,10 +27,12 @@ ID of the `acs_encoder` to use for the scan. [action\_attempt](./) -### `SCAN_CREDENTIAL` +### The `SCAN_CREDENTIAL` Resource Reading credential data from physical encoder. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index ce0feedd4..447d43527 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -2,10 +2,12 @@ The Entrances route contains the following resources: -## `acs_entrance` +## The `acs_entrance` Resource Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `acs_entrance_id` Format: `UUID` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index b5359816b..55c80b1b1 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -2,10 +2,12 @@ The Systems route contains the following resources: -## `acs_system` +## The `acs_system` Resource Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `acs_system_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 4a04b38cb..3685eb873 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -2,10 +2,12 @@ The ACS Users route contains the following resources: -## `acs_user` +## The `acs_user` Resource Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `access_schedule` Format: `Object` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 350b97e41..fc7b8b5b0 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -2,10 +2,12 @@ The Phones route contains the following resources: -## `phone` +## The `phone` Resource Represents an app user's mobile phone. +## Properties + ### `created_at` Format: `Datetime` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5b931e56a..3581cf675 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -168,10 +168,12 @@ ID of the desired thermostat device. [action\_attempt](./) -### `ACTIVATE_CLIMATE_PRESET` +### The `ACTIVATE_CLIMATE_PRESET` Resource Activating climate preset. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 182fc93ca..e5eeb887a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -178,10 +178,12 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 44c9ad73f..e94c92dfe 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -178,10 +178,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6003f60cc..e45bed8d1 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -202,10 +202,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b5b824710..b5d29835a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -150,10 +150,12 @@ ID of the desired thermostat device. [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 794091e4b..d368f6887 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -2,10 +2,12 @@ The Thermostat Schedules route contains the following resources: -## `thermostat_schedule` +## The `thermostat_schedule` Resource Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. +## Properties + ### `climate_preset_key` Format: `String` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index bdf5e7d33..cbc03d518 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -178,10 +178,12 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos [action\_attempt](./) -### `SET_FAN_MODE` +### The `SET_FAN_MODE` Resource Setting fan mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 64185341f..0619e31be 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -216,10 +216,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 602814b4b..0655fc022 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -2,10 +2,12 @@ The User Identities route contains the following resources: -## `user_identity` +## The `user_identity` Resource Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +## Properties + ### `created_at` Format: `Datetime` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 890683324..0b1a2b65e 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -2,10 +2,12 @@ The Enrollment Automations route contains the following resources: -## `enrollment_automation` +## The `enrollment_automation` Resource Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). +## Properties + ### `created_at` Format: `Datetime` From 1373b454bfabb1a4b497817967b5a3dcb9631691 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:25:11 -0400 Subject: [PATCH 09/60] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 8897755d3..eebb7080d 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,7 +8,7 @@ {{description}} {{/if}} -{{#if headingOffset}} +{{#if ../headingOffset}} #### Properties {{else}} ## Properties @@ -16,9 +16,9 @@ {{#each properties}} {{#if ../headingOffset}} -#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} +##### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} {{else}} -### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} +#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} {{/if}} {{#if isDeprecated}} From e05c000960315dcd1afb996d00d3def8ba45e3c7 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:26:11 +0000 Subject: [PATCH 10/60] ci: Generate docs --- docs/api/acs/access_groups/README.md | 24 ++++----- docs/api/acs/credentials/README.md | 52 +++++++++---------- docs/api/acs/encoders/README.md | 12 ++--- docs/api/acs/encoders/encode_credential.md | 12 ++--- docs/api/acs/encoders/scan_credential.md | 12 ++--- docs/api/acs/entrances/README.md | 22 ++++---- docs/api/acs/systems/README.md | 44 ++++++++-------- docs/api/acs/users/README.md | 42 +++++++-------- docs/api/phones/README.md | 20 +++---- .../thermostats/activate_climate_preset.md | 12 ++--- docs/api/thermostats/cool.md | 12 ++--- docs/api/thermostats/heat.md | 12 ++--- docs/api/thermostats/heat_cool.md | 12 ++--- docs/api/thermostats/off.md | 12 ++--- docs/api/thermostats/schedules/README.md | 18 +++---- docs/api/thermostats/set_fan_mode.md | 12 ++--- docs/api/thermostats/set_hvac_mode.md | 12 ++--- docs/api/user_identities/README.md | 16 +++--- .../enrollment_automations/README.md | 10 ++-- 19 files changed, 184 insertions(+), 184 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index b03ebddae..175433c8f 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -9,7 +9,7 @@ The `acs_access_group` object represents an [access group](https://docs.seam.co/ ## Properties -### `access_group_type` +#### `access_group_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -27,7 +27,7 @@ Possible enum values: --- -### `access_group_type_display_name` +#### `access_group_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -37,7 +37,7 @@ Format: `String` --- -### `acs_access_group_id` +#### `acs_access_group_id` Format: `UUID` @@ -45,7 +45,7 @@ ID of the access group. --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -53,7 +53,7 @@ ID of the access control system that contains the access group. --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -61,13 +61,13 @@ Date and time at which the access group was created. --- -### `display_name` +#### `display_name` Format: `String` --- -### `external_type` +#### `external_type` Format: `Enum` @@ -83,7 +83,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -91,13 +91,13 @@ Display name that corresponds to the brand-specific terminology for the access g --- -### `is_managed` +#### `is_managed` Format: `Boolean` --- -### `name` +#### `name` Format: `String` @@ -105,7 +105,7 @@ Name of the access group. --- -### `warnings` +#### `warnings` Format: `List` @@ -139,7 +139,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 18756514c..e762fdbae 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -8,7 +8,7 @@ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/acces ## Properties -### `access_method` +#### `access_method` Format: `Enum` @@ -21,7 +21,7 @@ Possible enum values: --- -### `acs_credential_id` +#### `acs_credential_id` Format: `UUID` @@ -29,13 +29,13 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden --- -### `acs_credential_pool_id` +#### `acs_credential_pool_id` Format: `UUID` --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -43,7 +43,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `acs_user_id` +#### `acs_user_id` Format: `UUID` @@ -51,7 +51,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -### `assa_abloy_vostio_metadata` +#### `assa_abloy_vostio_metadata` Format: `Object` @@ -89,7 +89,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -### `card_number` +#### `card_number` Format: `String` @@ -97,7 +97,7 @@ Number of the card associated with the [credential](../../../capability-guides/a --- -### `code` +#### `code` Format: `String` @@ -105,7 +105,7 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -113,7 +113,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `display_name` +#### `display_name` Format: `String` @@ -121,7 +121,7 @@ Display name that corresponds to the [credential](../../../capability-guides/acc --- -### `ends_at` +#### `ends_at` Format: `String` @@ -129,7 +129,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `errors` +#### `errors` Format: `List` @@ -151,7 +151,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -### `external_type` +#### `external_type` Format: `Enum` @@ -168,7 +168,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -176,7 +176,7 @@ Display name that corresponds to the brand-specific terminology for the [credent --- -### `is_issued` +#### `is_issued` Format: `Boolean` @@ -184,7 +184,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -### `is_latest_desired_state_synced_with_provider` +#### `is_latest_desired_state_synced_with_provider` Format: `Boolean` @@ -192,13 +192,13 @@ Indicates whether the latest state of the [credential](../../../capability-guide --- -### `is_managed` +#### `is_managed` Format: `Boolean` --- -### `is_multi_phone_sync_credential` +#### `is_multi_phone_sync_credential` Format: `Boolean` @@ -206,7 +206,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -### `is_one_time_use` +#### `is_one_time_use` Format: `Boolean` @@ -214,7 +214,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -### `issued_at` +#### `issued_at` Format: `Datetime` @@ -222,7 +222,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `latest_desired_state_synced_with_provider_at` +#### `latest_desired_state_synced_with_provider_at` Format: `Datetime` @@ -230,7 +230,7 @@ Date and time at which the state of the [credential](../../../capability-guides/ --- -### `parent_acs_credential_id` +#### `parent_acs_credential_id` Format: `UUID` @@ -238,7 +238,7 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing --- -### `starts_at` +#### `starts_at` Format: `String` @@ -246,7 +246,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` @@ -306,7 +306,7 @@ Possible enum values: --- -### [`warnings`](./#warnings-1) +#### [`warnings`](./#warnings-1) Format: `List` @@ -316,7 +316,7 @@ Warnings associated with the [credential](../../../capability-guides/access-syst --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 90948c79d..ea4a0607f 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -8,7 +8,7 @@ Represents a hardware device that encodes [credential](../../../capability-guide ## Properties -### `acs_encoder_id` +#### `acs_encoder_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -32,7 +32,7 @@ Date and time at which the [encoder](../../../capability-guides/access-systems/w --- -### `display_name` +#### `display_name` Format: `String` @@ -40,7 +40,7 @@ Display name for the [encoder](../../../capability-guides/access-systems/working --- -### `errors` +#### `errors` Format: `List` @@ -74,7 +74,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 36a2096f1..a08e6241d 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -40,9 +40,9 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Encoding credential data from physical encoder. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -50,13 +50,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -81,7 +81,7 @@ Possible enum values: --- -#### `result` +##### `result` Format: `Object` @@ -433,7 +433,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 91078e1d8..2ea0ff24a 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -31,9 +31,9 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -41,13 +41,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -70,7 +70,7 @@ Possible enum values: --- -#### `result` +##### `result` Format: `Object` @@ -604,7 +604,7 @@ Possible enum values: --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 447d43527..847fac9f5 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,7 +8,7 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en ## Properties -### `acs_entrance_id` +#### `acs_entrance_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [entrance](../../../capability-guides/access-systems/retrieving-entran --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `assa_abloy_vostio_metadata` +#### `assa_abloy_vostio_metadata` Format: `Object` @@ -68,7 +68,7 @@ Possible enum values: --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -76,7 +76,7 @@ Date and time at which the [entrance](../../../capability-guides/access-systems/ --- -### `display_name` +#### `display_name` Format: `String` @@ -84,7 +84,7 @@ Display name for the [entrance](../../../capability-guides/access-systems/retrie --- -### `dormakaba_community_metadata` +#### `dormakaba_community_metadata` Format: `Object` @@ -98,7 +98,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -### `errors` +#### `errors` Format: `List` @@ -124,7 +124,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `latch_metadata` +#### `latch_metadata` Format: `Object` @@ -156,7 +156,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -### `salto_ks_metadata` +#### `salto_ks_metadata` Format: `Object` @@ -212,7 +212,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -### `salto_space_metadata` +#### `salto_space_metadata` Format: `Object` @@ -238,7 +238,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 55c80b1b1..e6c256b48 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -8,7 +8,7 @@ Represents an [access control system](https://docs.seam.co/latest/capability-gui ## Properties -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `can_add_acs_users_to_acs_access_groups` +#### `can_add_acs_users_to_acs_access_groups` Format: `Boolean` @@ -24,7 +24,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -### `can_automate_enrollment` +#### `can_automate_enrollment` Format: `Boolean` @@ -32,7 +32,7 @@ Indicates whether it is possible to [launch enrollment automations](../../../cap --- -### `can_create_acs_access_groups` +#### `can_create_acs_access_groups` Format: `Boolean` @@ -40,7 +40,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -### `can_remove_acs_users_from_acs_access_groups` +#### `can_remove_acs_users_from_acs_access_groups` Format: `Boolean` @@ -48,7 +48,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -### `connected_account_id` +#### `connected_account_id` Format: `UUID` @@ -56,7 +56,7 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m --- -### `connected_account_ids` +#### `connected_account_ids` {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. @@ -70,7 +70,7 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -78,7 +78,7 @@ Date and time at which the [access control system](https://docs.seam.co/latest/c --- -### `default_credential_manager_acs_system_id` +#### `default_credential_manager_acs_system_id` Format: `UUID` @@ -86,7 +86,7 @@ ID of the default credential manager `acs_system` for this [access control syste --- -### [`errors`](./#errors-1) +#### [`errors`](./#errors-1) Format: `List` @@ -96,7 +96,7 @@ Errors associated with the [access control system](https://docs.seam.co/latest/c --- -### `external_type` +#### `external_type` Format: `Enum` @@ -119,7 +119,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -127,7 +127,7 @@ Display name that corresponds to the brand-specific terminology for the [access --- -### `image_alt_text` +#### `image_alt_text` Format: `String` @@ -135,7 +135,7 @@ Alternative text for the [access control system](https://docs.seam.co/latest/cap --- -### `image_url` +#### `image_url` Format: `String` @@ -143,7 +143,7 @@ URL for the image that represents the [access control system](https://docs.seam. --- -### `is_credential_manager` +#### `is_credential_manager` Format: `Boolean` @@ -151,7 +151,7 @@ Indicates whether the `acs_system` is a credential manager. --- -### `location` +#### `location` Format: `Object` @@ -165,7 +165,7 @@ Time zone in which the [access control system](https://docs.seam.co/latest/capab --- -### `name` +#### `name` Format: `String` @@ -173,7 +173,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -### `system_type` +#### `system_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -198,7 +198,7 @@ Possible enum values: --- -### `system_type_display_name` +#### `system_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -208,7 +208,7 @@ Format: `String` --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` @@ -238,7 +238,7 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i --- -### [`warnings`](./#warnings-1) +#### [`warnings`](./#warnings-1) Format: `List` @@ -248,7 +248,7 @@ Warnings associated with the [access control system](https://docs.seam.co/latest --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 3685eb873..f42e0e4c7 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -8,7 +8,7 @@ Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems ## Properties -### `access_schedule` +#### `access_schedule` Format: `Object` @@ -32,7 +32,7 @@ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.o --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `acs_user_id` +#### `acs_user_id` Format: `UUID` @@ -48,7 +48,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -56,7 +56,7 @@ Date and time at which the [ACS user](https://docs.seam.co/latest/capability-gui --- -### `display_name` +#### `display_name` Format: `String` @@ -64,7 +64,7 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -### `email` +#### `email` {% hint style="warning" %} **Deprecated**. use email_address. @@ -74,7 +74,7 @@ Format: `String` --- -### `email_address` +#### `email_address` Format: `String` @@ -82,7 +82,7 @@ Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -### [`errors`](./#errors-1) +#### [`errors`](./#errors-1) Format: `List` @@ -92,7 +92,7 @@ Errors associated with the [ACS user](https://docs.seam.co/latest/capability-gui --- -### `external_type` +#### `external_type` Format: `Enum` @@ -109,7 +109,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -117,7 +117,7 @@ Display name that corresponds to the brand-specific terminology for the [ACS use --- -### `full_name` +#### `full_name` Format: `String` @@ -125,19 +125,19 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access --- -### `hid_acs_system_id` +#### `hid_acs_system_id` Format: `UUID` --- -### `is_managed` +#### `is_managed` Format: `Boolean` --- -### `is_suspended` +#### `is_suspended` Format: `Boolean` @@ -145,7 +145,7 @@ Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/a --- -### `phone_number` +#### `phone_number` Format: `String` @@ -153,7 +153,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -### `user_identity_email_address` +#### `user_identity_email_address` Format: `String` @@ -161,7 +161,7 @@ Email address of the user identity associated with the [ACS user](https://docs.s --- -### `user_identity_full_name` +#### `user_identity_full_name` Format: `String` @@ -169,7 +169,7 @@ Full name of the user identity associated with the [ACS user](https://docs.seam. --- -### `user_identity_id` +#### `user_identity_id` Format: `String` @@ -177,7 +177,7 @@ ID of the user identity associated with the [ACS user](https://docs.seam.co/late --- -### `user_identity_phone_number` +#### `user_identity_phone_number` Format: `String` @@ -185,7 +185,7 @@ Phone number of the user identity associated with the [ACS user](https://docs.se --- -### [`warnings`](./#warnings-1) +#### [`warnings`](./#warnings-1) Format: `List` @@ -195,7 +195,7 @@ Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-g --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index fc7b8b5b0..1980a4865 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -8,7 +8,7 @@ Represents an app user's mobile phone. ## Properties -### `created_at` +#### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the `phone` was created. --- -### `custom_metadata` +#### `custom_metadata` Format: `Record` @@ -24,7 +24,7 @@ Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to --- -### `device_id` +#### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the `phone`. --- -### `device_type` +#### `device_type` Format: `Enum` @@ -44,7 +44,7 @@ Possible enum values: --- -### `display_name` +#### `display_name` Format: `String` @@ -52,7 +52,7 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. --- -### `errors` +#### `errors` Format: `List` @@ -74,7 +74,7 @@ Errors associated with the `phone`. --- -### `nickname` +#### `nickname` Format: `String` @@ -82,7 +82,7 @@ Optional nickname to describe the phone, settable through Seam. --- -### `properties` +#### `properties` Format: `Object` @@ -146,7 +146,7 @@ Indicates whether the credential service has an active associated phone. --- -### `warnings` +#### `warnings` Format: `List` @@ -168,7 +168,7 @@ Warnings associated with the `phone`. --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 3581cf675..f389bd98d 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -172,9 +172,9 @@ ID of the desired thermostat device. Activating climate preset. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -182,13 +182,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -206,7 +206,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -214,7 +214,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index e5eeb887a..c11883961 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -182,9 +182,9 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e94c92dfe..e572ed4aa 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -182,9 +182,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e45bed8d1..6ccc97c7c 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -206,9 +206,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -216,13 +216,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -240,7 +240,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -248,7 +248,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b5d29835a..8499e4124 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -154,9 +154,9 @@ ID of the desired thermostat device. Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -164,13 +164,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -188,7 +188,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -196,7 +196,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index d368f6887..f48dbb861 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -8,7 +8,7 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -### `climate_preset_key` +#### `climate_preset_key` Format: `String` @@ -16,7 +16,7 @@ Key of the [climate preset](../../../capability-guides/thermostats/creating-and- --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -24,7 +24,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -### `device_id` +#### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/the --- -### `ends_at` +#### `ends_at` Format: `Datetime` @@ -40,7 +40,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -### `errors` +#### `errors` Format: `List` @@ -66,7 +66,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `max_override_period_minutes` +#### `max_override_period_minutes` Format: `Number` @@ -74,7 +74,7 @@ Number of minutes for which a person at the thermostat can change the thermostat --- -### `name` +#### `name` Format: `String` @@ -82,7 +82,7 @@ User-friendly name to identify the [thermostat schedule](../../../capability-gui --- -### `starts_at` +#### `starts_at` Format: `Datetime` @@ -90,7 +90,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -### `thermostat_schedule_id` +#### `thermostat_schedule_id` Format: `UUID` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index cbc03d518..9c801e3aa 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -182,9 +182,9 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0619e31be..b60e9003a 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -220,9 +220,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -230,13 +230,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -254,7 +254,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -262,7 +262,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 0655fc022..6453bfe0e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -8,7 +8,7 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -### `created_at` +#### `created_at` Format: `Datetime` @@ -16,13 +16,13 @@ Date and time at which the user identity was created. --- -### `display_name` +#### `display_name` Format: `String` --- -### `email_address` +#### `email_address` Format: `String` @@ -30,13 +30,13 @@ Unique email address for the user identity. --- -### `full_name` +#### `full_name` Format: `String` --- -### `phone_number` +#### `phone_number` Format: `String` @@ -44,7 +44,7 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/ --- -### `user_identity_id` +#### `user_identity_id` Format: `UUID` @@ -52,7 +52,7 @@ ID of the user identity. --- -### `user_identity_key` +#### `user_identity_key` Format: `String` @@ -60,7 +60,7 @@ Unique key for the user identity. --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 0b1a2b65e..a7ed61101 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -8,7 +8,7 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -### `created_at` +#### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the enrollment automation was created. --- -### `credential_manager_acs_system_id` +#### `credential_manager_acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/ --- -### `enrollment_automation_id` +#### `enrollment_automation_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the enrollment automation. --- -### `user_identity_id` +#### `user_identity_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the associated [user identity](https://docs.seam.co/latest/capability-guid --- -### `workspace_id` +#### `workspace_id` Format: `UUID` From 11f9f89f56f27720683b95955c732f2391e75047 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:31:10 -0400 Subject: [PATCH 11/60] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index eebb7080d..ee55e650b 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,17 +8,17 @@ {{description}} {{/if}} -{{#if ../headingOffset}} +{{#if headingOffset}} #### Properties {{else}} -## Properties +### Properties {{/if}} {{#each properties}} {{#if ../headingOffset}} -##### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} -{{else}} #### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} +{{else}} +### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} {{/if}} {{#if isDeprecated}} From a801425db2273d5b0a2dadd8e42e16b168dae03f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:32:17 +0000 Subject: [PATCH 12/60] ci: Generate docs --- docs/api/acs/access_groups/README.md | 26 ++++----- docs/api/acs/credentials/README.md | 54 +++++++++---------- docs/api/acs/encoders/README.md | 14 ++--- docs/api/acs/encoders/encode_credential.md | 12 ++--- docs/api/acs/encoders/scan_credential.md | 12 ++--- docs/api/acs/entrances/README.md | 24 ++++----- docs/api/acs/systems/README.md | 46 ++++++++-------- docs/api/acs/users/README.md | 44 +++++++-------- docs/api/phones/README.md | 22 ++++---- .../thermostats/activate_climate_preset.md | 12 ++--- docs/api/thermostats/cool.md | 12 ++--- docs/api/thermostats/heat.md | 12 ++--- docs/api/thermostats/heat_cool.md | 12 ++--- docs/api/thermostats/off.md | 12 ++--- docs/api/thermostats/schedules/README.md | 20 +++---- docs/api/thermostats/set_fan_mode.md | 12 ++--- docs/api/thermostats/set_hvac_mode.md | 12 ++--- docs/api/user_identities/README.md | 18 +++---- .../enrollment_automations/README.md | 12 ++--- 19 files changed, 194 insertions(+), 194 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 175433c8f..fd2400a91 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -7,9 +7,9 @@ The Access Groups route contains the following resources: Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `access_group_type` +### `access_group_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -27,7 +27,7 @@ Possible enum values: --- -#### `access_group_type_display_name` +### `access_group_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -37,7 +37,7 @@ Format: `String` --- -#### `acs_access_group_id` +### `acs_access_group_id` Format: `UUID` @@ -45,7 +45,7 @@ ID of the access group. --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -53,7 +53,7 @@ ID of the access control system that contains the access group. --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -61,13 +61,13 @@ Date and time at which the access group was created. --- -#### `display_name` +### `display_name` Format: `String` --- -#### `external_type` +### `external_type` Format: `Enum` @@ -83,7 +83,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -91,13 +91,13 @@ Display name that corresponds to the brand-specific terminology for the access g --- -#### `is_managed` +### `is_managed` Format: `Boolean` --- -#### `name` +### `name` Format: `String` @@ -105,7 +105,7 @@ Name of the access group. --- -#### `warnings` +### `warnings` Format: `List` @@ -139,7 +139,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index e762fdbae..554994b65 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -6,9 +6,9 @@ The Credentials route contains the following resources: Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. -## Properties +### Properties -#### `access_method` +### `access_method` Format: `Enum` @@ -21,7 +21,7 @@ Possible enum values: --- -#### `acs_credential_id` +### `acs_credential_id` Format: `UUID` @@ -29,13 +29,13 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden --- -#### `acs_credential_pool_id` +### `acs_credential_pool_id` Format: `UUID` --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -43,7 +43,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `acs_user_id` +### `acs_user_id` Format: `UUID` @@ -51,7 +51,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -#### `assa_abloy_vostio_metadata` +### `assa_abloy_vostio_metadata` Format: `Object` @@ -89,7 +89,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -#### `card_number` +### `card_number` Format: `String` @@ -97,7 +97,7 @@ Number of the card associated with the [credential](../../../capability-guides/a --- -#### `code` +### `code` Format: `String` @@ -105,7 +105,7 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -113,7 +113,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `display_name` +### `display_name` Format: `String` @@ -121,7 +121,7 @@ Display name that corresponds to the [credential](../../../capability-guides/acc --- -#### `ends_at` +### `ends_at` Format: `String` @@ -129,7 +129,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `errors` +### `errors` Format: `List` @@ -151,7 +151,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -#### `external_type` +### `external_type` Format: `Enum` @@ -168,7 +168,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -176,7 +176,7 @@ Display name that corresponds to the brand-specific terminology for the [credent --- -#### `is_issued` +### `is_issued` Format: `Boolean` @@ -184,7 +184,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -#### `is_latest_desired_state_synced_with_provider` +### `is_latest_desired_state_synced_with_provider` Format: `Boolean` @@ -192,13 +192,13 @@ Indicates whether the latest state of the [credential](../../../capability-guide --- -#### `is_managed` +### `is_managed` Format: `Boolean` --- -#### `is_multi_phone_sync_credential` +### `is_multi_phone_sync_credential` Format: `Boolean` @@ -206,7 +206,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -#### `is_one_time_use` +### `is_one_time_use` Format: `Boolean` @@ -214,7 +214,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -#### `issued_at` +### `issued_at` Format: `Datetime` @@ -222,7 +222,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `latest_desired_state_synced_with_provider_at` +### `latest_desired_state_synced_with_provider_at` Format: `Datetime` @@ -230,7 +230,7 @@ Date and time at which the state of the [credential](../../../capability-guides/ --- -#### `parent_acs_credential_id` +### `parent_acs_credential_id` Format: `UUID` @@ -238,7 +238,7 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing --- -#### `starts_at` +### `starts_at` Format: `String` @@ -246,7 +246,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `visionline_metadata` +### `visionline_metadata` Format: `Object` @@ -306,7 +306,7 @@ Possible enum values: --- -#### [`warnings`](./#warnings-1) +### [`warnings`](./#warnings-1) Format: `List` @@ -316,7 +316,7 @@ Warnings associated with the [credential](../../../capability-guides/access-syst --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index ea4a0607f..53ce78629 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -6,9 +6,9 @@ The Encoders route contains the following resources: Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -## Properties +### Properties -#### `acs_encoder_id` +### `acs_encoder_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -32,7 +32,7 @@ Date and time at which the [encoder](../../../capability-guides/access-systems/w --- -#### `display_name` +### `display_name` Format: `String` @@ -40,7 +40,7 @@ Display name for the [encoder](../../../capability-guides/access-systems/working --- -#### `errors` +### `errors` Format: `List` @@ -74,7 +74,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index a08e6241d..36a2096f1 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -40,9 +40,9 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Encoding credential data from physical encoder. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -50,13 +50,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -81,7 +81,7 @@ Possible enum values: --- -##### `result` +#### `result` Format: `Object` @@ -433,7 +433,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 2ea0ff24a..91078e1d8 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -31,9 +31,9 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -41,13 +41,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -70,7 +70,7 @@ Possible enum values: --- -##### `result` +#### `result` Format: `Object` @@ -604,7 +604,7 @@ Possible enum values: --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 847fac9f5..1662bd413 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -6,9 +6,9 @@ The Entrances route contains the following resources: Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `acs_entrance_id` +### `acs_entrance_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [entrance](../../../capability-guides/access-systems/retrieving-entran --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `assa_abloy_vostio_metadata` +### `assa_abloy_vostio_metadata` Format: `Object` @@ -68,7 +68,7 @@ Possible enum values: --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -76,7 +76,7 @@ Date and time at which the [entrance](../../../capability-guides/access-systems/ --- -#### `display_name` +### `display_name` Format: `String` @@ -84,7 +84,7 @@ Display name for the [entrance](../../../capability-guides/access-systems/retrie --- -#### `dormakaba_community_metadata` +### `dormakaba_community_metadata` Format: `Object` @@ -98,7 +98,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -#### `errors` +### `errors` Format: `List` @@ -124,7 +124,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -#### `latch_metadata` +### `latch_metadata` Format: `Object` @@ -156,7 +156,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -#### `salto_ks_metadata` +### `salto_ks_metadata` Format: `Object` @@ -212,7 +212,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -#### `salto_space_metadata` +### `salto_space_metadata` Format: `Object` @@ -238,7 +238,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -#### `visionline_metadata` +### `visionline_metadata` Format: `Object` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index e6c256b48..37d7ff779 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -6,9 +6,9 @@ The Systems route contains the following resources: Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `can_add_acs_users_to_acs_access_groups` +### `can_add_acs_users_to_acs_access_groups` Format: `Boolean` @@ -24,7 +24,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -#### `can_automate_enrollment` +### `can_automate_enrollment` Format: `Boolean` @@ -32,7 +32,7 @@ Indicates whether it is possible to [launch enrollment automations](../../../cap --- -#### `can_create_acs_access_groups` +### `can_create_acs_access_groups` Format: `Boolean` @@ -40,7 +40,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -#### `can_remove_acs_users_from_acs_access_groups` +### `can_remove_acs_users_from_acs_access_groups` Format: `Boolean` @@ -48,7 +48,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -#### `connected_account_id` +### `connected_account_id` Format: `UUID` @@ -56,7 +56,7 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m --- -#### `connected_account_ids` +### `connected_account_ids` {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. @@ -70,7 +70,7 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -78,7 +78,7 @@ Date and time at which the [access control system](https://docs.seam.co/latest/c --- -#### `default_credential_manager_acs_system_id` +### `default_credential_manager_acs_system_id` Format: `UUID` @@ -86,7 +86,7 @@ ID of the default credential manager `acs_system` for this [access control syste --- -#### [`errors`](./#errors-1) +### [`errors`](./#errors-1) Format: `List` @@ -96,7 +96,7 @@ Errors associated with the [access control system](https://docs.seam.co/latest/c --- -#### `external_type` +### `external_type` Format: `Enum` @@ -119,7 +119,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -127,7 +127,7 @@ Display name that corresponds to the brand-specific terminology for the [access --- -#### `image_alt_text` +### `image_alt_text` Format: `String` @@ -135,7 +135,7 @@ Alternative text for the [access control system](https://docs.seam.co/latest/cap --- -#### `image_url` +### `image_url` Format: `String` @@ -143,7 +143,7 @@ URL for the image that represents the [access control system](https://docs.seam. --- -#### `is_credential_manager` +### `is_credential_manager` Format: `Boolean` @@ -151,7 +151,7 @@ Indicates whether the `acs_system` is a credential manager. --- -#### `location` +### `location` Format: `Object` @@ -165,7 +165,7 @@ Time zone in which the [access control system](https://docs.seam.co/latest/capab --- -#### `name` +### `name` Format: `String` @@ -173,7 +173,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -#### `system_type` +### `system_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -198,7 +198,7 @@ Possible enum values: --- -#### `system_type_display_name` +### `system_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -208,7 +208,7 @@ Format: `String` --- -#### `visionline_metadata` +### `visionline_metadata` Format: `Object` @@ -238,7 +238,7 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i --- -#### [`warnings`](./#warnings-1) +### [`warnings`](./#warnings-1) Format: `List` @@ -248,7 +248,7 @@ Warnings associated with the [access control system](https://docs.seam.co/latest --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index f42e0e4c7..f337d8f3b 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -6,9 +6,9 @@ The ACS Users route contains the following resources: Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `access_schedule` +### `access_schedule` Format: `Object` @@ -32,7 +32,7 @@ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.o --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `acs_user_id` +### `acs_user_id` Format: `UUID` @@ -48,7 +48,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -56,7 +56,7 @@ Date and time at which the [ACS user](https://docs.seam.co/latest/capability-gui --- -#### `display_name` +### `display_name` Format: `String` @@ -64,7 +64,7 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -#### `email` +### `email` {% hint style="warning" %} **Deprecated**. use email_address. @@ -74,7 +74,7 @@ Format: `String` --- -#### `email_address` +### `email_address` Format: `String` @@ -82,7 +82,7 @@ Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -#### [`errors`](./#errors-1) +### [`errors`](./#errors-1) Format: `List` @@ -92,7 +92,7 @@ Errors associated with the [ACS user](https://docs.seam.co/latest/capability-gui --- -#### `external_type` +### `external_type` Format: `Enum` @@ -109,7 +109,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -117,7 +117,7 @@ Display name that corresponds to the brand-specific terminology for the [ACS use --- -#### `full_name` +### `full_name` Format: `String` @@ -125,19 +125,19 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access --- -#### `hid_acs_system_id` +### `hid_acs_system_id` Format: `UUID` --- -#### `is_managed` +### `is_managed` Format: `Boolean` --- -#### `is_suspended` +### `is_suspended` Format: `Boolean` @@ -145,7 +145,7 @@ Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/a --- -#### `phone_number` +### `phone_number` Format: `String` @@ -153,7 +153,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -#### `user_identity_email_address` +### `user_identity_email_address` Format: `String` @@ -161,7 +161,7 @@ Email address of the user identity associated with the [ACS user](https://docs.s --- -#### `user_identity_full_name` +### `user_identity_full_name` Format: `String` @@ -169,7 +169,7 @@ Full name of the user identity associated with the [ACS user](https://docs.seam. --- -#### `user_identity_id` +### `user_identity_id` Format: `String` @@ -177,7 +177,7 @@ ID of the user identity associated with the [ACS user](https://docs.seam.co/late --- -#### `user_identity_phone_number` +### `user_identity_phone_number` Format: `String` @@ -185,7 +185,7 @@ Phone number of the user identity associated with the [ACS user](https://docs.se --- -#### [`warnings`](./#warnings-1) +### [`warnings`](./#warnings-1) Format: `List` @@ -195,7 +195,7 @@ Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-g --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 1980a4865..40cfc1e80 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,9 +6,9 @@ The Phones route contains the following resources: Represents an app user's mobile phone. -## Properties +### Properties -#### `created_at` +### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the `phone` was created. --- -#### `custom_metadata` +### `custom_metadata` Format: `Record` @@ -24,7 +24,7 @@ Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to --- -#### `device_id` +### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the `phone`. --- -#### `device_type` +### `device_type` Format: `Enum` @@ -44,7 +44,7 @@ Possible enum values: --- -#### `display_name` +### `display_name` Format: `String` @@ -52,7 +52,7 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. --- -#### `errors` +### `errors` Format: `List` @@ -74,7 +74,7 @@ Errors associated with the `phone`. --- -#### `nickname` +### `nickname` Format: `String` @@ -82,7 +82,7 @@ Optional nickname to describe the phone, settable through Seam. --- -#### `properties` +### `properties` Format: `Object` @@ -146,7 +146,7 @@ Indicates whether the credential service has an active associated phone. --- -#### `warnings` +### `warnings` Format: `List` @@ -168,7 +168,7 @@ Warnings associated with the `phone`. --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index f389bd98d..3581cf675 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -172,9 +172,9 @@ ID of the desired thermostat device. Activating climate preset. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -182,13 +182,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -206,7 +206,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -214,7 +214,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index c11883961..e5eeb887a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -182,9 +182,9 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e572ed4aa..e94c92dfe 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -182,9 +182,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6ccc97c7c..e45bed8d1 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -206,9 +206,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -216,13 +216,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -240,7 +240,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -248,7 +248,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 8499e4124..b5d29835a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -154,9 +154,9 @@ ID of the desired thermostat device. Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -164,13 +164,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -188,7 +188,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -196,7 +196,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index f48dbb861..8eb560191 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,9 +6,9 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. -## Properties +### Properties -#### `climate_preset_key` +### `climate_preset_key` Format: `String` @@ -16,7 +16,7 @@ Key of the [climate preset](../../../capability-guides/thermostats/creating-and- --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -24,7 +24,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -#### `device_id` +### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/the --- -#### `ends_at` +### `ends_at` Format: `Datetime` @@ -40,7 +40,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -#### `errors` +### `errors` Format: `List` @@ -66,7 +66,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -#### `max_override_period_minutes` +### `max_override_period_minutes` Format: `Number` @@ -74,7 +74,7 @@ Number of minutes for which a person at the thermostat can change the thermostat --- -#### `name` +### `name` Format: `String` @@ -82,7 +82,7 @@ User-friendly name to identify the [thermostat schedule](../../../capability-gui --- -#### `starts_at` +### `starts_at` Format: `Datetime` @@ -90,7 +90,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -#### `thermostat_schedule_id` +### `thermostat_schedule_id` Format: `UUID` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 9c801e3aa..cbc03d518 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -182,9 +182,9 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index b60e9003a..0619e31be 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -220,9 +220,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -230,13 +230,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -254,7 +254,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -262,7 +262,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 6453bfe0e..07800df08 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,9 +6,9 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. -## Properties +### Properties -#### `created_at` +### `created_at` Format: `Datetime` @@ -16,13 +16,13 @@ Date and time at which the user identity was created. --- -#### `display_name` +### `display_name` Format: `String` --- -#### `email_address` +### `email_address` Format: `String` @@ -30,13 +30,13 @@ Unique email address for the user identity. --- -#### `full_name` +### `full_name` Format: `String` --- -#### `phone_number` +### `phone_number` Format: `String` @@ -44,7 +44,7 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/ --- -#### `user_identity_id` +### `user_identity_id` Format: `UUID` @@ -52,7 +52,7 @@ ID of the user identity. --- -#### `user_identity_key` +### `user_identity_key` Format: `String` @@ -60,7 +60,7 @@ Unique key for the user identity. --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index a7ed61101..7f4938ee8 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,9 +6,9 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). -## Properties +### Properties -#### `created_at` +### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the enrollment automation was created. --- -#### `credential_manager_acs_system_id` +### `credential_manager_acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/ --- -#### `enrollment_automation_id` +### `enrollment_automation_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the enrollment automation. --- -#### `user_identity_id` +### `user_identity_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the associated [user identity](https://docs.seam.co/latest/capability-guid --- -#### `workspace_id` +### `workspace_id` Format: `UUID` From 34737c51bde7e544d0633fe20bdb6e4cd0a3aedc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:35:31 -0400 Subject: [PATCH 13/60] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index ee55e650b..e4768fa74 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -9,9 +9,9 @@ {{/if}} {{#if headingOffset}} -#### Properties -{{else}} ### Properties +{{else}} +## Properties {{/if}} {{#each properties}} From 04705d9c0e3639aa643b4d59841dfbc9232bac2a Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:36:32 +0000 Subject: [PATCH 14/60] ci: Generate docs --- docs/api/acs/access_groups/README.md | 2 +- docs/api/acs/credentials/README.md | 2 +- docs/api/acs/encoders/README.md | 2 +- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/entrances/README.md | 2 +- docs/api/acs/systems/README.md | 2 +- docs/api/acs/users/README.md | 2 +- docs/api/phones/README.md | 2 +- docs/api/thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/README.md | 2 +- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- docs/api/user_identities/README.md | 2 +- docs/api/user_identities/enrollment_automations/README.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index fd2400a91..b03ebddae 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -7,7 +7,7 @@ The Access Groups route contains the following resources: Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `access_group_type` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 554994b65..18756514c 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -6,7 +6,7 @@ The Credentials route contains the following resources: Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. -### Properties +## Properties ### `access_method` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 53ce78629..90948c79d 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -6,7 +6,7 @@ The Encoders route contains the following resources: Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -### Properties +## Properties ### `acs_encoder_id` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 36a2096f1..a626b06ca 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -40,7 +40,7 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Encoding credential data from physical encoder. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 91078e1d8..8ebba014d 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -31,7 +31,7 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 1662bd413..447d43527 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -6,7 +6,7 @@ The Entrances route contains the following resources: Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `acs_entrance_id` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 37d7ff779..55c80b1b1 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -6,7 +6,7 @@ The Systems route contains the following resources: Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `acs_system_id` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index f337d8f3b..3685eb873 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -6,7 +6,7 @@ The ACS Users route contains the following resources: Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `access_schedule` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 40cfc1e80..fc7b8b5b0 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,7 +6,7 @@ The Phones route contains the following resources: Represents an app user's mobile phone. -### Properties +## Properties ### `created_at` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 3581cf675..350ad3cae 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -172,7 +172,7 @@ ID of the desired thermostat device. Activating climate preset. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index e5eeb887a..77d36b7aa 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -182,7 +182,7 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e94c92dfe..4b8658a2d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -182,7 +182,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e45bed8d1..fb0ec58bc 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -206,7 +206,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b5d29835a..0e187e167 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -154,7 +154,7 @@ ID of the desired thermostat device. Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 8eb560191..d368f6887 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,7 +6,7 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. -### Properties +## Properties ### `climate_preset_key` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index cbc03d518..50ca28637 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -182,7 +182,7 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0619e31be..a08ccb187 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -220,7 +220,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 07800df08..0655fc022 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,7 +6,7 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. -### Properties +## Properties ### `created_at` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 7f4938ee8..0b1a2b65e 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,7 +6,7 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). -### Properties +## Properties ### `created_at` From a0140ac1662c65ed66d6b52eaf862e65920be466 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:15:43 -0400 Subject: [PATCH 15/60] Update acs-users.yaml --- .../code-sample-definitions/acs-users.yaml | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/src/data/code-sample-definitions/acs-users.yaml b/src/data/code-sample-definitions/acs-users.yaml index 77bd23cd8..c09f27b8c 100644 --- a/src/data/code-sample-definitions/acs-users.yaml +++ b/src/data/code-sample-definitions/acs-users.yaml @@ -1,6 +1,49 @@ --- - title: 'Create a new ACS user' description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).' + request: + path: '/acs/users/create' + parameters: + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' + response: + body: + acs_user: + acs_user_id: '123e4567-e89b-12d3-a456-426614174000' + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + workspace_id: '123e4567-e89b-12d3-a456-426614174000' + created_at: '2024-04-05T07:57:05.323Z' + display_name: 'Jane Doe' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' +- title: 'Create a new ACS user' + description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule.' + request: + path: '/acs/users/create' + parameters: + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' + access_schedule: + starts_at: '2024-11-01T15:00:00.000Z' + ends_at: '2024-11-04T11:00:00.000Z' + response: + body: + acs_user: + acs_user_id: '123e4567-e89b-12d3-a456-426614174000' + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + workspace_id: '123e4567-e89b-12d3-a456-426614174000' + created_at: '2024-04-05T07:57:05.323Z' + display_name: 'Jane Doe' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' +- title: 'Create a new ACS user in an access group' + description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).' request: path: '/acs/users/create' parameters: From c614e4e22a538c8af14a86df367779d2894550e9 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:16:44 +0000 Subject: [PATCH 16/60] ci: Generate docs --- docs/api/acs/users/create.md | 349 +++++++++++++++++++++++++++++++++++ 1 file changed, 349 insertions(+) diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 6137a24e7..20a37cbdf 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -10,6 +10,355 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-sy {% tab title="JavaScript" %} #### Request +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + access_schedule={ + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: [ + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-04T11:00:00.000Z", + ] +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% tab title="JavaScript" %} +#### Request + ```javascript await seam.acs.users.create({ acs_system_id: "123e4567-e89b-12d3-a456-426614174000", From 5519bcffe6be5cfbe5939cd1fb060a4e7468df93 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:21:07 +0000 Subject: [PATCH 17/60] ci: Generate docs --- docs/api/acs/entrances/README.md | 2 ++ docs/api/acs/systems/README.md | 2 ++ docs/api/acs/users/README.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index a6312457d..3a0f02725 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,6 +8,8 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. +## Properties + ### `acs_entrance_id` Format: `UUID` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 5697d778e..b3faa7fa5 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -10,6 +10,8 @@ Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs). +## Properties + ### `acs_system_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 460f53235..a43216b0d 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -10,6 +10,8 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +## Properties + ### `access_schedule` Format: `Object` From 802f992846f72635e0de44bdc0bcca48a93fd95f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:47:07 -0400 Subject: [PATCH 18/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 1e41aec61..695fd5015 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -7,10 +7,10 @@ {{{description}}} {{#if codeSamples.length}} -{% tabs %} {{#each codeSamples}} +{% tabs %} {{#each this.code}} -{% tab title="{{this.title}}" %} +{% tab title="{{this.title}} TEST" %} #### Request ```{{@key}} From 5268d8f61e79b718018246e52f416f229959ab81 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:48:04 +0000 Subject: [PATCH 19/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 12 +++--- docs/api/acs/access_groups/get.md | 12 +++--- docs/api/acs/access_groups/list.md | 12 +++--- .../list_accessible_entrances.md | 12 +++--- docs/api/acs/access_groups/list_users.md | 12 +++--- docs/api/acs/access_groups/remove_user.md | 12 +++--- docs/api/acs/credentials/assign.md | 12 +++--- docs/api/acs/credentials/create.md | 12 +++--- docs/api/acs/credentials/delete.md | 12 +++--- docs/api/acs/credentials/get.md | 12 +++--- docs/api/acs/credentials/list.md | 12 +++--- .../credentials/list_accessible_entrances.md | 12 +++--- docs/api/acs/credentials/unassign.md | 12 +++--- docs/api/acs/credentials/update.md | 12 +++--- docs/api/acs/entrances/get.md | 12 +++--- docs/api/acs/entrances/list.md | 12 +++--- .../entrances/list_credentials_with_access.md | 12 +++--- docs/api/acs/systems/get.md | 12 +++--- docs/api/acs/systems/list.md | 12 +++--- ...mpatible_credential_manager_acs_systems.md | 12 +++--- docs/api/acs/users/add_to_access_group.md | 12 +++--- docs/api/acs/users/create.md | 38 ++++++++++--------- docs/api/acs/users/delete.md | 12 +++--- docs/api/acs/users/get.md | 12 +++--- docs/api/acs/users/list.md | 12 +++--- .../api/acs/users/remove_from_access_group.md | 12 +++--- docs/api/acs/users/suspend.md | 12 +++--- docs/api/acs/users/unsuspend.md | 12 +++--- docs/api/acs/users/update.md | 12 +++--- .../thermostats/activate_climate_preset.md | 12 +++--- docs/api/thermostats/cool.md | 12 +++--- docs/api/thermostats/create_climate_preset.md | 12 +++--- docs/api/thermostats/delete_climate_preset.md | 12 +++--- docs/api/thermostats/heat.md | 12 +++--- docs/api/thermostats/heat_cool.md | 12 +++--- docs/api/thermostats/list.md | 12 +++--- docs/api/thermostats/off.md | 12 +++--- docs/api/thermostats/schedules/create.md | 12 +++--- docs/api/thermostats/schedules/delete.md | 12 +++--- docs/api/thermostats/schedules/get.md | 12 +++--- docs/api/thermostats/schedules/list.md | 12 +++--- docs/api/thermostats/schedules/update.md | 12 +++--- .../set_fallback_climate_preset.md | 12 +++--- docs/api/thermostats/set_fan_mode.md | 12 +++--- docs/api/thermostats/set_hvac_mode.md | 12 +++--- .../thermostats/set_temperature_threshold.md | 12 +++--- docs/api/thermostats/update_climate_preset.md | 12 +++--- docs/api/user_identities/add_acs_user.md | 12 +++--- docs/api/user_identities/create.md | 12 +++--- docs/api/user_identities/delete.md | 12 +++--- .../enrollment_automations/delete.md | 12 +++--- .../enrollment_automations/get.md | 12 +++--- .../enrollment_automations/launch.md | 12 +++--- .../enrollment_automations/list.md | 12 +++--- docs/api/user_identities/get.md | 12 +++--- .../user_identities/grant_access_to_device.md | 12 +++--- docs/api/user_identities/list.md | 12 +++--- .../list_accessible_devices.md | 12 +++--- docs/api/user_identities/list_acs_systems.md | 12 +++--- docs/api/user_identities/list_acs_users.md | 12 +++--- docs/api/user_identities/remove_acs_user.md | 12 +++--- .../revoke_access_to_device.md | 12 +++--- 62 files changed, 386 insertions(+), 384 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 983d05410..ec8c530c7 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -7,7 +7,7 @@ PUT /acs/access_groups/add_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.accessGroups.addUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e33a8cb19..a2322f7ce 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -7,7 +7,7 @@ POST /acs/access_groups/get ⇒ { acs_access_group } Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -34,7 +34,7 @@ await seam.acs.accessGroups.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -59,7 +59,7 @@ AcsAccessGroup( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -84,7 +84,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -113,7 +113,7 @@ $seam->acs->access_groups->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -138,7 +138,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 103b790ba..4864901b8 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -7,7 +7,7 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -37,7 +37,7 @@ await seam.acs.accessGroups.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -67,7 +67,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -97,7 +97,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -129,7 +129,7 @@ $seam->acs->access_groups->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -156,7 +156,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 265ab76d3..6eaa6c4d8 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -7,7 +7,7 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -57,7 +57,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -82,7 +82,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -109,7 +109,7 @@ $seam->acs->access_groups->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -132,7 +132,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index c366a94a6..ddad886c1 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -7,7 +7,7 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -44,7 +44,7 @@ await seam.acs.accessGroups.listUsers({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -81,7 +81,7 @@ seam.acs.access_groups.list_users( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -116,7 +116,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -155,7 +155,7 @@ $seam->acs->access_groups->list_users( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -190,7 +190,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6902f8394..2eca16489 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -7,7 +7,7 @@ POST /acs/access_groups/remove_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.accessGroups.removeUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index e1cae31f5..834f543b3 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -7,7 +7,7 @@ PATCH /acs/credentials/assign ⇒ void Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.credentials.assign({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index af1e25bfe..01a2b4434 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -7,7 +7,7 @@ POST /acs/credentials/create ⇒ { acs_credential } Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -42,7 +42,7 @@ await seam.acs.credentials.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -77,7 +77,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -112,7 +112,7 @@ seam.acs.credentials.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -149,7 +149,7 @@ $seam->acs->credentials->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -173,7 +173,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 9a0fee13f..16de68075 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -7,7 +7,7 @@ POST /acs/credentials/delete ⇒ void Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.credentials.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -68,7 +68,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -82,7 +82,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 649794cee..bb1217312 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -7,7 +7,7 @@ POST /acs/credentials/get ⇒ { acs_credential } Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -33,7 +33,7 @@ await seam.acs.credentials.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -57,7 +57,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -81,7 +81,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -109,7 +109,7 @@ $seam->acs->credentials->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -133,7 +133,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 2f656b113..e2ad59fb8 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -7,7 +7,7 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -38,7 +38,7 @@ await seam.acs.credentials.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -69,7 +69,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -100,7 +100,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -133,7 +133,7 @@ $seam->acs->credentials->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -159,7 +159,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" - ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3dddcd871..5db94f202 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -7,7 +7,7 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -42,7 +42,7 @@ await seam.acs.credentials.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -77,7 +77,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -107,7 +107,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -144,7 +144,7 @@ $seam->acs->credentials->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -177,7 +177,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 187a30eb3..264c237db 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -7,7 +7,7 @@ PATCH /acs/credentials/unassign ⇒ void Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.credentials.unassign({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 549c4a2b5..c6721e70d 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -7,7 +7,7 @@ PATCH /acs/credentials/update ⇒ void Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.credentials.update({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -54,7 +54,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -72,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -86,7 +86,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index b4bbbbdf4..734bd8887 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -7,7 +7,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.acs.entrances.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -47,7 +47,7 @@ AcsEntrance( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -66,7 +66,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -89,7 +89,7 @@ $seam->acs->entrances->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -108,7 +108,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index acf540d23..54fcee250 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -7,7 +7,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.acs.entrances.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -49,7 +49,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -70,7 +70,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -93,7 +93,7 @@ $seam->acs->entrances->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -114,7 +114,7 @@ seam acs entrances list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6cd85a7bf..053d62a32 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -7,7 +7,7 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -46,7 +46,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -85,7 +85,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -124,7 +124,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -166,7 +166,7 @@ $seam->acs->entrances->list_credentials_with_access( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -203,7 +203,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index a4c54c150..e1fa0bbaa 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -9,7 +9,7 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -25,7 +25,7 @@ await seam.acs.systems.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -39,7 +39,7 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -53,7 +53,7 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -69,7 +69,7 @@ $seam->acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -83,7 +83,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 61766cfe3..32b1ab1fc 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -11,7 +11,7 @@ To filter the list of returned access control systems by a specific connected ac response includes all access control systems connected to your workspace. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -27,7 +27,7 @@ await seam.acs.systems.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -55,7 +55,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -73,7 +73,7 @@ $seam->acs->systems->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -87,7 +87,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 64204002a..c5a3e276a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -11,7 +11,7 @@ Specify the ACS system for which you want to retrieve all compatible credential systems by including the corresponding `acs_system_id` in the request body. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -27,7 +27,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -43,7 +43,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -59,7 +59,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -77,7 +77,7 @@ $seam->acs->systems->list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -91,7 +91,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 220fea9d0..93fdd17fb 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -7,7 +7,7 @@ PUT /acs/users/add_to_access_group ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.users.addToAccessGroup({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 20a37cbdf..2641bb68e 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -7,7 +7,7 @@ POST /acs/users/create ⇒ { acs_user } Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -35,7 +35,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -63,7 +63,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -91,7 +91,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -121,7 +121,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -144,7 +144,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go @@ -173,7 +173,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} -{% tab title="JavaScript" %} +{% tabs %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -205,7 +206,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -237,7 +238,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -269,7 +270,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -303,7 +304,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -326,7 +327,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go @@ -356,7 +357,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} -{% tab title="JavaScript" %} +{% tabs %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -385,7 +387,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -414,7 +416,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -443,7 +445,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -474,7 +476,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -497,7 +499,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index fcae60e5b..dce805a1a 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -7,7 +7,7 @@ POST /acs/users/delete ⇒ void Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.users.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -66,7 +66,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -80,7 +80,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 997149da3..f02cebce3 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -7,7 +7,7 @@ POST /acs/users/get ⇒ { acs_user } Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.acs.users.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -78,7 +78,7 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -103,7 +103,7 @@ $seam->acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -126,7 +126,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index b23c5a49e..d5939d529 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -7,7 +7,7 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -30,7 +30,7 @@ await seam.acs.users.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -53,7 +53,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -76,7 +76,7 @@ seam.acs.users.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -101,7 +101,7 @@ $seam->acs->users->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -124,7 +124,7 @@ seam acs users list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7a5808809..90412f2b7 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -7,7 +7,7 @@ POST /acs/users/remove_from_access_group ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.users.removeFromAccessGroup({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 3e7988c69..841c5bf23 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -7,7 +7,7 @@ POST /acs/users/suspend ⇒ void [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.users.suspend({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -66,7 +66,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -80,7 +80,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index e2f624dd0..07baad2b3 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -7,7 +7,7 @@ POST /acs/users/unsuspend ⇒ void [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.users.unsuspend({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -68,7 +68,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -82,7 +82,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index dccb7c8af..19d4df4e1 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -7,7 +7,7 @@ PATCH /acs/users/update ⇒ void Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.users.update({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -57,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -75,7 +75,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -89,7 +89,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 2f654e1d3..8400c4589 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.activateClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.activate_climate_preset( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->activate_climate_preset( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9794da83a..905835b43 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -7,7 +7,7 @@ POST /thermostats/cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.cool({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.cool( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->cool( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 069c4b3c5..862b657e4 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/create_climate_preset ⇒ void Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -30,7 +30,7 @@ await seam.thermostats.createClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -53,7 +53,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -76,7 +76,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -100,7 +100,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -114,7 +114,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 570123781..d862f9094 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/delete_climate_preset ⇒ void Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.thermostats.deleteClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -57,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -75,7 +75,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -89,7 +89,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index bb1189645..f77d3f637 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -7,7 +7,7 @@ POST /thermostats/heat ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.heat({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.heat( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->heat( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e29392489..6d8a9b3e4 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -7,7 +7,7 @@ POST /thermostats/heat_cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -29,7 +29,7 @@ await seam.thermostats.heatCool({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -51,7 +51,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -73,7 +73,7 @@ seam.thermostats.heat_cool( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -97,7 +97,7 @@ $seam->thermostats->heat_cool( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -115,7 +115,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" -- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f0adedbe6..40f4daa30 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -7,7 +7,7 @@ POST /thermostats/list ⇒ { devices: [device, …] } Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -44,7 +44,7 @@ await seam.thermostats.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -81,7 +81,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -118,7 +118,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -162,7 +162,7 @@ $seam->thermostats->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -199,7 +199,7 @@ seam thermostats list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 0242bd842..e447ba0a6 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -7,7 +7,7 @@ POST /thermostats/off ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -27,7 +27,7 @@ await seam.thermostats.off({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -45,7 +45,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -63,7 +63,7 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -83,7 +83,7 @@ $seam->thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -101,7 +101,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 834ad88a1..6e15e4043 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -36,7 +36,7 @@ await seam.thermostats.schedules.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -65,7 +65,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -94,7 +94,7 @@ seam.thermostats.schedules.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -125,7 +125,7 @@ $seam->thermostats->schedules->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -147,7 +147,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index ca4fc4575..fa2febb2a 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/delete ⇒ void Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.thermostats.schedules.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -39,7 +39,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -53,7 +53,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -70,7 +70,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -84,7 +84,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1534426d7..be6d39e57 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -31,7 +31,7 @@ await seam.thermostats.schedules.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -77,7 +77,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -103,7 +103,7 @@ $seam->thermostats->schedules->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -125,7 +125,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3ee8d7463..f61fdaaee 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -42,7 +42,7 @@ await seam.thermostats.schedules.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -75,7 +75,7 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -108,7 +108,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -145,7 +145,7 @@ $seam->thermostats->schedules->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -178,7 +178,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 3c72f533a..773774b87 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -7,7 +7,7 @@ PATCH /thermostats/schedules/update ⇒ void Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.thermostats.schedules.update({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2cbfe3e09..248ac1b00 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/set_fallback_climate_preset ⇒ void Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.thermostats.setFallbackClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -57,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -75,7 +75,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -89,7 +89,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 8f42e6633..f07e2ccc8 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -7,7 +7,7 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.setFanMode({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.set_fan_mode( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->set_fan_mode( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 05e2f4bb8..92cd1cefa 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -7,7 +7,7 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -30,7 +30,7 @@ await seam.thermostats.setHvacMode({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -53,7 +53,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -76,7 +76,7 @@ seam.thermostats.set_hvac_mode( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -101,7 +101,7 @@ $seam->thermostats->set_hvac_mode( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -119,7 +119,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index ca66a4ecc..0ff0003f3 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -7,7 +7,7 @@ PATCH /thermostats/set_temperature_threshold ⇒ void Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -25,7 +25,7 @@ await seam.thermostats.setTemperatureThreshold({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -43,7 +43,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -61,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -80,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -94,7 +94,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 777f9bc9e..8c5d6022b 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -7,7 +7,7 @@ PATCH /thermostats/update_climate_preset ⇒ void Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -26,7 +26,7 @@ await seam.thermostats.updateClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -45,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -64,7 +64,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -84,7 +84,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -98,7 +98,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index af928ae44..90421eeef 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -7,7 +7,7 @@ PUT /user_identities/add_acs_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.addAcsUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 817473e5c..4326f5640 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -7,7 +7,7 @@ POST /user_identities/create ⇒ { user_identity } Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -35,7 +35,7 @@ await seam.userIdentities.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -63,7 +63,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -91,7 +91,7 @@ seam.user_identities.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -121,7 +121,7 @@ $seam->user_identities->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -144,7 +144,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 2bdc55ac5..0c0720b35 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -7,7 +7,7 @@ POST /user_identities/delete ⇒ void Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.userIdentities.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -68,7 +68,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -82,7 +82,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 2e1962b93..54cbe59d3 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/delete ⇒ void Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -39,7 +39,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -55,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -72,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -86,7 +86,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index b53917f31..67530c3e3 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -31,7 +31,7 @@ await seam.userIdentities.enrollmentAutomations.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ EnrollmentAutomation( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -79,7 +79,7 @@ seam.user_identities.enrollment_automations.get( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -107,7 +107,7 @@ $seam->user_identities->enrollment_automations->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -129,7 +129,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 5dc340903..a23e5b103 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -34,7 +34,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -61,7 +61,7 @@ Unknown( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -88,7 +88,7 @@ seam.user_identities.enrollment_automations.launch( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -119,7 +119,7 @@ $seam->user_identities->enrollment_automations->launch( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -141,7 +141,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 8ed1a89c7..49009f4fc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -33,7 +33,7 @@ await seam.userIdentities.enrollmentAutomations.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -59,7 +59,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -85,7 +85,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -115,7 +115,7 @@ $seam->user_identities->enrollment_automations->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -139,7 +139,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a76dbf454..001cd912a 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -7,7 +7,7 @@ POST /user_identities/get ⇒ { user_identity } Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.userIdentities.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -78,7 +78,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -105,7 +105,7 @@ $seam->user_identities->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -128,7 +128,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index b5121cc74..b63120782 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -7,7 +7,7 @@ PUT /user_identities/grant_access_to_device ⇒ void Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.grantAccessToDevice({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7044c7aaa..e23c138b8 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -7,7 +7,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.userIdentities.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -57,7 +57,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -82,7 +82,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -109,7 +109,7 @@ $seam->user_identities->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -134,7 +134,7 @@ seam user-identities list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index e84acbefb..65f9c77fe 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -7,7 +7,7 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -75,7 +75,7 @@ await seam.userIdentities.listAccessibleDevices({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -143,7 +143,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -215,7 +215,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -292,7 +292,7 @@ $seam->user_identities->list_accessible_devices( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -358,7 +358,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 27b7403e1..b16202e11 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -7,7 +7,7 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -35,7 +35,7 @@ await seam.userIdentities.listAcsSystems({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -63,7 +63,7 @@ seam.user_identities.list_acs_systems( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -89,7 +89,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -119,7 +119,7 @@ $seam->user_identities->list_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -145,7 +145,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index d585f3090..de3f8bdc1 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -7,7 +7,7 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -37,7 +37,7 @@ await seam.userIdentities.listAcsUsers({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -67,7 +67,7 @@ seam.user_identities.list_acs_users( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -95,7 +95,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -127,7 +127,7 @@ $seam->user_identities->list_acs_users( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -155,7 +155,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 9ddac01d2..348533b75 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -7,7 +7,7 @@ POST /user_identities/remove_acs_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.removeAcsUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index bf09b47be..9d9de2ef4 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -7,7 +7,7 @@ POST /user_identities/revoke_access_to_device ⇒ void Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.revokeAccessToDevice({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go From 8ec7f59eb13e4210963f8ad56dd029c5cd7e2b85 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:50:09 -0400 Subject: [PATCH 20/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 695fd5015..0cef66c32 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -8,9 +8,13 @@ {{#if codeSamples.length}} {{#each codeSamples}} +## {{this.title}} + +{{this.description}} + {% tabs %} {{#each this.code}} -{% tab title="{{this.title}} TEST" %} +{% tab title="{{this.title}}" %} #### Request ```{{@key}} @@ -24,10 +28,9 @@ ``` {% endtab %} -{{/each}} {{/each}} {% endtabs %} - +{{/each}} {{/if}} {{#if authMethods}} ## Authentication Methods From 09dcacca88df8b67dea44ffd7aac2a66ff9fed1f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:51:09 +0000 Subject: [PATCH 21/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 17 ++++--- docs/api/acs/access_groups/get.md | 17 ++++--- docs/api/acs/access_groups/list.md | 17 ++++--- .../list_accessible_entrances.md | 17 ++++--- docs/api/acs/access_groups/list_users.md | 17 ++++--- docs/api/acs/access_groups/remove_user.md | 17 ++++--- docs/api/acs/credentials/assign.md | 17 ++++--- docs/api/acs/credentials/create.md | 17 ++++--- docs/api/acs/credentials/delete.md | 17 ++++--- docs/api/acs/credentials/get.md | 17 ++++--- docs/api/acs/credentials/list.md | 17 ++++--- .../credentials/list_accessible_entrances.md | 17 ++++--- docs/api/acs/credentials/unassign.md | 17 ++++--- docs/api/acs/credentials/update.md | 17 ++++--- docs/api/acs/entrances/get.md | 17 ++++--- docs/api/acs/entrances/list.md | 17 ++++--- .../entrances/list_credentials_with_access.md | 17 ++++--- docs/api/acs/systems/get.md | 17 ++++--- docs/api/acs/systems/list.md | 17 ++++--- ...mpatible_credential_manager_acs_systems.md | 17 ++++--- docs/api/acs/users/add_to_access_group.md | 17 ++++--- docs/api/acs/users/create.md | 51 ++++++++++++------- docs/api/acs/users/delete.md | 17 ++++--- docs/api/acs/users/get.md | 17 ++++--- docs/api/acs/users/list.md | 17 ++++--- .../api/acs/users/remove_from_access_group.md | 17 ++++--- docs/api/acs/users/suspend.md | 17 ++++--- docs/api/acs/users/unsuspend.md | 17 ++++--- docs/api/acs/users/update.md | 17 ++++--- .../thermostats/activate_climate_preset.md | 17 ++++--- docs/api/thermostats/cool.md | 17 ++++--- docs/api/thermostats/create_climate_preset.md | 17 ++++--- docs/api/thermostats/delete_climate_preset.md | 17 ++++--- docs/api/thermostats/heat.md | 17 ++++--- docs/api/thermostats/heat_cool.md | 17 ++++--- docs/api/thermostats/list.md | 17 ++++--- docs/api/thermostats/off.md | 17 ++++--- docs/api/thermostats/schedules/create.md | 17 ++++--- docs/api/thermostats/schedules/delete.md | 17 ++++--- docs/api/thermostats/schedules/get.md | 17 ++++--- docs/api/thermostats/schedules/list.md | 17 ++++--- docs/api/thermostats/schedules/update.md | 17 ++++--- .../set_fallback_climate_preset.md | 17 ++++--- docs/api/thermostats/set_fan_mode.md | 17 ++++--- docs/api/thermostats/set_hvac_mode.md | 17 ++++--- .../thermostats/set_temperature_threshold.md | 17 ++++--- docs/api/thermostats/update_climate_preset.md | 17 ++++--- docs/api/user_identities/add_acs_user.md | 17 ++++--- docs/api/user_identities/create.md | 17 ++++--- docs/api/user_identities/delete.md | 17 ++++--- .../enrollment_automations/delete.md | 17 ++++--- .../enrollment_automations/get.md | 17 ++++--- .../enrollment_automations/launch.md | 17 ++++--- .../enrollment_automations/list.md | 17 ++++--- docs/api/user_identities/get.md | 17 ++++--- .../user_identities/grant_access_to_device.md | 17 ++++--- docs/api/user_identities/list.md | 17 ++++--- .../list_accessible_devices.md | 17 ++++--- docs/api/user_identities/list_acs_systems.md | 17 ++++--- docs/api/user_identities/list_acs_users.md | 17 ++++--- docs/api/user_identities/remove_acs_user.md | 17 ++++--- .../revoke_access_to_device.md | 17 ++++--- 62 files changed, 642 insertions(+), 446 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index ec8c530c7..2c7bf69b6 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -6,8 +6,12 @@ PUT /acs/access_groups/add_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Add an ACS user to an access group + +Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.accessGroups.addUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index a2322f7ce..e206f704c 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -6,8 +6,12 @@ POST /acs/access_groups/get ⇒ { acs_access_group } Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Get a specific access group + +Specify the `acs_access_group_id` of the access group that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -34,7 +38,7 @@ await seam.acs.accessGroups.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -59,7 +63,7 @@ AcsAccessGroup( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -84,7 +88,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -113,7 +117,7 @@ $seam->acs->access_groups->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -138,7 +142,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -165,7 +169,6 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 4864901b8..70efeda96 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -6,8 +6,12 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## List access groups + +To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -37,7 +41,7 @@ await seam.acs.accessGroups.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -67,7 +71,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -97,7 +101,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -129,7 +133,7 @@ $seam->acs->access_groups->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -156,7 +160,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -184,7 +188,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 6eaa6c4d8..46e0fb964 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -6,8 +6,12 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## List accessible entrances for an access group + +Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -57,7 +61,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -82,7 +86,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -109,7 +113,7 @@ $seam->acs->access_groups->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -132,7 +136,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -159,7 +163,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index ddad886c1..d099bf156 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -6,8 +6,12 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## List ACS users in an access group + +Specify the `acs_access_group_id` to retrieve all ACS users in an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -44,7 +48,7 @@ await seam.acs.accessGroups.listUsers({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -81,7 +85,7 @@ seam.acs.access_groups.list_users( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -116,7 +120,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -155,7 +159,7 @@ $seam->acs->access_groups->list_users( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -190,7 +194,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -217,7 +221,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 2eca16489..161a62830 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -6,8 +6,12 @@ POST /acs/access_groups/remove_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Remove an ACS user from an access group + +Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.accessGroups.removeUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 834f543b3..53f6ed344 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -6,8 +6,12 @@ PATCH /acs/credentials/assign ⇒ void Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Assign a credential to an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.credentials.assign({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 01a2b4434..db9ddf2e3 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -6,8 +6,12 @@ POST /acs/credentials/create ⇒ { acs_credential } Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Create a credential for an ACS user + +Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -42,7 +46,7 @@ await seam.acs.credentials.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -77,7 +81,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -112,7 +116,7 @@ seam.acs.credentials.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -149,7 +153,7 @@ $seam->acs->credentials->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -173,7 +177,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -206,7 +210,6 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 16de68075..17dc00afb 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -6,8 +6,12 @@ POST /acs/credentials/delete ⇒ void Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +## Delete a credential + +Specify the desired `acs_credential_id` to delete the specified credential. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.credentials.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -68,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -82,7 +86,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -109,7 +113,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index bb1217312..d98f72ca4 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -6,8 +6,12 @@ POST /acs/credentials/get ⇒ { acs_credential } Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +## Get a credential + +Specify the `acs_credential_id` of the credential that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -33,7 +37,7 @@ await seam.acs.credentials.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -57,7 +61,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -81,7 +85,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -109,7 +113,7 @@ $seam->acs->credentials->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -133,7 +137,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -160,7 +164,6 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index e2ad59fb8..3f9791c47 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -6,8 +6,12 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). +## List credentials + +Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -38,7 +42,7 @@ await seam.acs.credentials.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -69,7 +73,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -100,7 +104,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -133,7 +137,7 @@ $seam->acs->credentials->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -159,7 +163,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" - ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -189,7 +193,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 5db94f202..a77cf978d 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -6,8 +6,12 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. +## List accessible entrances + +Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -42,7 +46,7 @@ await seam.acs.credentials.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -77,7 +81,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -107,7 +111,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -144,7 +148,7 @@ $seam->acs->credentials->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -177,7 +181,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -204,7 +208,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 264c237db..e7fa89f16 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -6,8 +6,12 @@ PATCH /acs/credentials/unassign ⇒ void Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Unassign a credential from an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.credentials.unassign({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index c6721e70d..2d8502e70 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -6,8 +6,12 @@ PATCH /acs/credentials/update ⇒ void Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +## Update a credential + +Specify the desired `acs_credential_id` and updated `code` to update the credential. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.credentials.update({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -54,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -72,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -86,7 +90,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -114,7 +118,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 734bd8887..3d5c4d908 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -6,8 +6,12 @@ POST /acs/entrances/get ⇒ { acs_entrance } Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +## Get an entrance + +Specify the `acs_entrance_id` of the entrance that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.acs.entrances.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -47,7 +51,7 @@ AcsEntrance( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -66,7 +70,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -89,7 +93,7 @@ $seam->acs->entrances->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -108,7 +112,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -135,7 +139,6 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 54fcee250..5d3eec62d 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -6,8 +6,12 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). +## List entrances + +To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.acs.entrances.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -49,7 +53,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -70,7 +74,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -93,7 +97,7 @@ $seam->acs->entrances->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -114,7 +118,7 @@ seam acs entrances list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -133,7 +137,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 053d62a32..6f96ce7fe 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -6,8 +6,12 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +## List credentials with access to an entrance + +Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -46,7 +50,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -85,7 +89,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -124,7 +128,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -166,7 +170,7 @@ $seam->acs->entrances->list_credentials_with_access( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -203,7 +207,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -230,7 +234,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index e1fa0bbaa..63a4959ca 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -8,8 +8,12 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. +## Get a Specific ACS system + +Specify the `acs_system_id` of the ACS system that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -25,7 +29,7 @@ await seam.acs.systems.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -39,7 +43,7 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -53,7 +57,7 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -69,7 +73,7 @@ $seam->acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -83,7 +87,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -110,7 +114,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 32b1ab1fc..aade874d2 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -10,8 +10,12 @@ To filter the list of returned access control systems by a specific connected ac `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. +## List ACS systems by connected account + +To filter the list of ACS systems, include a `connected_account_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -27,7 +31,7 @@ await seam.acs.systems.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -55,7 +59,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -73,7 +77,7 @@ $seam->acs->systems->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -87,7 +91,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -114,7 +118,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index c5a3e276a..6db41acc3 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -10,8 +10,12 @@ Returns a list of all credential manager ACS systems that are compatible with a Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. +## List compatible credential manager ACS systems + +Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -27,7 +31,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -43,7 +47,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -59,7 +63,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -77,7 +81,7 @@ $seam->acs->systems->list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -91,7 +95,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 93fdd17fb..e1b640b59 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -6,8 +6,12 @@ PUT /acs/users/add_to_access_group ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Add an ACS user to an access group + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.users.addToAccessGroup({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 2641bb68e..5213f5e45 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -6,8 +6,12 @@ POST /acs/users/create ⇒ { acs_user } Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -35,7 +39,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -63,7 +67,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -91,7 +95,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -121,7 +125,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -144,7 +148,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -173,8 +177,13 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} +{% endtabs %} +## Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -206,7 +215,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -238,7 +247,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -270,7 +279,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -304,7 +313,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -327,7 +336,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -357,8 +366,13 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} +{% endtabs %} +## Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -387,7 +401,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -416,7 +430,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -445,7 +459,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -476,7 +490,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -499,7 +513,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -530,7 +544,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index dce805a1a..ae6f78535 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -6,8 +6,12 @@ POST /acs/users/delete ⇒ void Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). +## Delete an ACS user + +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.users.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -66,7 +70,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -80,7 +84,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -107,7 +111,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index f02cebce3..48b33f7b5 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -6,8 +6,12 @@ POST /acs/users/get ⇒ { acs_user } Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Get a specific ACS user + +Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.acs.users.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -78,7 +82,7 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -103,7 +107,7 @@ $seam->acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -126,7 +130,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -153,7 +157,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index d5939d529..f0a22d044 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -6,8 +6,12 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## List all ACS users + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -30,7 +34,7 @@ await seam.acs.users.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -53,7 +57,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -76,7 +80,7 @@ seam.acs.users.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -101,7 +105,7 @@ $seam->acs->users->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -124,7 +128,7 @@ seam acs users list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -143,7 +147,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 90412f2b7..b66a08f2b 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -6,8 +6,12 @@ POST /acs/users/remove_from_access_group ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Remove an ACS user from an access group + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.users.removeFromAccessGroup({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 841c5bf23..e49074db2 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -6,8 +6,12 @@ POST /acs/users/suspend ⇒ void [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. +## Suspend an ACS user + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.users.suspend({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -66,7 +70,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -80,7 +84,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -107,7 +111,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 07baad2b3..8ca3d0f22 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -6,8 +6,12 @@ POST /acs/users/unsuspend ⇒ void [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. +## Unsuspend an ACS user + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.users.unsuspend({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -68,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -82,7 +86,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -109,7 +113,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 19d4df4e1..2b0b499e1 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -6,8 +6,12 @@ PATCH /acs/users/update ⇒ void Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Update an ACS user + +Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.users.update({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -57,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -75,7 +79,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -89,7 +93,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 8400c4589..958544873 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Activate a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.activateClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.activate_climate_preset( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->activate_climate_preset( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 905835b43..cbd50743e 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -6,8 +6,12 @@ POST /thermostats/cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to cool mode + +Specify the desired cooling set point in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.cool({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.cool( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->cool( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 862b657e4..f89b97c88 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/create_climate_preset ⇒ void Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Create a climate preset + +Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -30,7 +34,7 @@ await seam.thermostats.createClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -53,7 +57,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -76,7 +80,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -100,7 +104,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -114,7 +118,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -147,7 +151,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index d862f9094..05dadf8a3 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/delete_climate_preset ⇒ void Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Delete a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.thermostats.deleteClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -57,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -75,7 +79,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -89,7 +93,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -116,7 +120,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index f77d3f637..4fec06289 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -6,8 +6,12 @@ POST /thermostats/heat ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to heat mode + +Specify the desired heating set point in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.heat({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.heat( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->heat( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6d8a9b3e4..b1b660f81 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -6,8 +6,12 @@ POST /thermostats/heat_cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to heat-cool (auto) mode + +Specify the desired heating set point in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -29,7 +33,7 @@ await seam.thermostats.heatCool({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -51,7 +55,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -73,7 +77,7 @@ seam.thermostats.heat_cool( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -97,7 +101,7 @@ $seam->thermostats->heat_cool( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -115,7 +119,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" -- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -143,7 +147,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 40f4daa30..f1b56dd92 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -6,8 +6,12 @@ POST /thermostats/list ⇒ { devices: [device, …] } Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). +## List thermostats + +To filter the list of returned thermostats, specify the desired parameters. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -44,7 +48,7 @@ await seam.thermostats.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -81,7 +85,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -118,7 +122,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -162,7 +166,7 @@ $seam->thermostats->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -199,7 +203,7 @@ seam thermostats list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -218,7 +222,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index e447ba0a6..143fb0841 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -6,8 +6,12 @@ POST /thermostats/off ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to off mode + +Specify the `device_id` of the thermostat that you want to set to off mode. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -27,7 +31,7 @@ await seam.thermostats.off({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -45,7 +49,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -63,7 +67,7 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -83,7 +87,7 @@ $seam->thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -101,7 +105,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -127,7 +131,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 6e15e4043..77b3445f7 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Create a thermostat schedule + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -36,7 +40,7 @@ await seam.thermostats.schedules.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -65,7 +69,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -94,7 +98,7 @@ seam.thermostats.schedules.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -125,7 +129,7 @@ $seam->thermostats->schedules->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -147,7 +151,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -179,7 +183,6 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index fa2febb2a..7f7532003 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/delete ⇒ void Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Delete a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.thermostats.schedules.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -39,7 +43,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -53,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -70,7 +74,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -84,7 +88,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -111,7 +115,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index be6d39e57..b75581bc5 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +## Get a specific thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -31,7 +35,7 @@ await seam.thermostats.schedules.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -77,7 +81,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -103,7 +107,7 @@ $seam->thermostats->schedules->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -125,7 +129,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -152,7 +156,6 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index f61fdaaee..ef5e66b3d 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## List thermostat schedules for a thermostat + +Specify the `device_id` of the desired thermostat. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -42,7 +46,7 @@ await seam.thermostats.schedules.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -75,7 +79,7 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -108,7 +112,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -145,7 +149,7 @@ $seam->thermostats->schedules->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -178,7 +182,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -205,7 +209,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 773774b87..0889ea147 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -6,8 +6,12 @@ PATCH /thermostats/schedules/update ⇒ void Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +## Update a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.thermostats.schedules.update({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 248ac1b00..24c644ebc 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/set_fallback_climate_preset ⇒ void Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Set the fallback climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.thermostats.setFallbackClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -57,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -75,7 +79,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -89,7 +93,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -116,7 +120,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index f07e2ccc8..dfa1bafc1 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -6,8 +6,12 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Set fan mode setting + +Specify the desired fan mode setting. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.setFanMode({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.set_fan_mode( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->set_fan_mode( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 92cd1cefa..85f530cf1 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -6,8 +6,12 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Set HVAC mode + +Specify the desired heating and cooling set points in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -30,7 +34,7 @@ await seam.thermostats.setHvacMode({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -53,7 +57,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -76,7 +80,7 @@ seam.thermostats.set_hvac_mode( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -101,7 +105,7 @@ $seam->thermostats->set_hvac_mode( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -119,7 +123,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -148,7 +152,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 0ff0003f3..e9425a28c 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -6,8 +6,12 @@ PATCH /thermostats/set_temperature_threshold ⇒ void Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. +## Set a temperature threshold + +Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -25,7 +29,7 @@ await seam.thermostats.setTemperatureThreshold({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -43,7 +47,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -61,7 +65,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -80,7 +84,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -94,7 +98,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -122,7 +126,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 8c5d6022b..186da7b28 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -6,8 +6,12 @@ PATCH /thermostats/update_climate_preset ⇒ void Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Update a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -26,7 +30,7 @@ await seam.thermostats.updateClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -45,7 +49,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -64,7 +68,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -84,7 +88,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -98,7 +102,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -127,7 +131,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 90421eeef..3edf37f08 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -6,8 +6,12 @@ PUT /user_identities/add_acs_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Add an ACS user to a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.addAcsUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 4326f5640..188c9bb5a 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -6,8 +6,12 @@ POST /user_identities/create ⇒ { user_identity } Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Create a user identity + +Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -35,7 +39,7 @@ await seam.userIdentities.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -63,7 +67,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -91,7 +95,7 @@ seam.user_identities.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -121,7 +125,7 @@ $seam->user_identities->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -144,7 +148,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -173,7 +177,6 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 0c0720b35..6a4fee0d4 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -6,8 +6,12 @@ POST /user_identities/delete ⇒ void Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. +## Delete a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.userIdentities.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -68,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -82,7 +86,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -108,7 +112,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 54cbe59d3..36b0ce73a 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/delete ⇒ void Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). +## Delete an enrollment automation + +Specify the desired `enrollment_automation_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -39,7 +43,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -55,7 +59,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -72,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -86,7 +90,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -113,7 +117,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 67530c3e3..a5fa0ec7e 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). +## Get an enrollment automation + +Specify the desired `enrollment_automation_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -31,7 +35,7 @@ await seam.userIdentities.enrollmentAutomations.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ EnrollmentAutomation( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -79,7 +83,7 @@ seam.user_identities.enrollment_automations.get( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -107,7 +111,7 @@ $seam->user_identities->enrollment_automations->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -129,7 +133,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -156,7 +160,6 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index a23e5b103..554e8e5c5 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). +## Launch an enrollment automation + +Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -34,7 +38,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -61,7 +65,7 @@ Unknown( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -88,7 +92,7 @@ seam.user_identities.enrollment_automations.launch( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -119,7 +123,7 @@ $seam->user_identities->enrollment_automations->launch( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -141,7 +145,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -171,7 +175,6 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 49009f4fc..1d85c81fb 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List enrollment automations + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -33,7 +37,7 @@ await seam.userIdentities.enrollmentAutomations.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -59,7 +63,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -85,7 +89,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -115,7 +119,7 @@ $seam->user_identities->enrollment_automations->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -139,7 +143,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -166,7 +170,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 001cd912a..8cd5b9bfb 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -6,8 +6,12 @@ POST /user_identities/get ⇒ { user_identity } Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Get a user identity + +Specify the `user_identity_id` of the user identity that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.userIdentities.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -78,7 +82,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -105,7 +109,7 @@ $seam->user_identities->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -128,7 +132,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -154,7 +158,6 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index b63120782..a1a815225 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -6,8 +6,12 @@ PUT /user_identities/grant_access_to_device ⇒ void Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). +## Grant a user identity access to a device + +Specify the desired `user_identity_id` and `device_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.grantAccessToDevice({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index e23c138b8..a94896839 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -6,8 +6,12 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List user identities + +To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.userIdentities.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -57,7 +61,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -82,7 +86,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -109,7 +113,7 @@ $seam->user_identities->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -134,7 +138,7 @@ seam user-identities list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -153,7 +157,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 65f9c77fe..9ac82b8ee 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -6,8 +6,12 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List accessible devices for a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -75,7 +79,7 @@ await seam.userIdentities.listAccessibleDevices({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -143,7 +147,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -215,7 +219,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -292,7 +296,7 @@ $seam->user_identities->list_accessible_devices( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -358,7 +362,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -384,7 +388,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index b16202e11..9e3de822e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -6,8 +6,12 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List ACS systems associated with a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -35,7 +39,7 @@ await seam.userIdentities.listAcsSystems({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -63,7 +67,7 @@ seam.user_identities.list_acs_systems( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -89,7 +93,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -119,7 +123,7 @@ $seam->user_identities->list_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -145,7 +149,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -171,7 +175,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index de3f8bdc1..3cc8ed5c3 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -6,8 +6,12 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List ACS users for a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -37,7 +41,7 @@ await seam.userIdentities.listAcsUsers({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -67,7 +71,7 @@ seam.user_identities.list_acs_users( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -95,7 +99,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -127,7 +131,7 @@ $seam->user_identities->list_acs_users( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -155,7 +159,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -181,7 +185,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 348533b75..a51c702af 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -6,8 +6,12 @@ POST /user_identities/remove_acs_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Remove an ACS user from a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.removeAcsUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 9d9de2ef4..a1deac4cc 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -6,8 +6,12 @@ POST /user_identities/revoke_access_to_device ⇒ void Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Revoke access to a device from a user identity + +Specify the desired `user_identity_id` and `device_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.revokeAccessToDevice({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key From 2d17524790e6a1385ba3584cc494d59fcedf8300 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:53:41 -0400 Subject: [PATCH 22/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 0cef66c32..da03adb50 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -7,7 +7,7 @@ {{{description}}} {{#if codeSamples.length}} -{{#each codeSamples}} +{{#each this.codeSamples}} ## {{this.title}} {{this.description}} From 7b55ca8ab76e417468c39cddc0d1f9d039fe5e3f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:57:14 -0400 Subject: [PATCH 23/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index da03adb50..4b6bee91f 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -30,6 +30,7 @@ {{/each}} {% endtabs %} + {{/each}} {{/if}} {{#if authMethods}} @@ -68,3 +69,35 @@ None {{> api-resource response.actionAttempt headingOffset=true}} {{/if}} + +*** + +## Code Samples + {{#if codeSamples.length}} +{{#each this.codeSamples}} +### {{this.title}} + +{{this.description}} + +{% tabs %} +{{#each this.code}} +{% tab title="{{this.title}}" %} +#### Request + +```{{@key}} +{{this.request}} +``` + +#### Response + +```{{@key}} +{{this.response}} +``` +{% endtab %} + +{{/each}} +{% endtabs %} + +{{/each}} +{{/if}} + From 56fb11c529a95f6e532183784e932c940acdeef1 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:58:11 +0000 Subject: [PATCH 24/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 123 ++++ docs/api/acs/access_groups/get.md | 170 ++++++ docs/api/acs/access_groups/list.md | 189 ++++++ .../list_accessible_entrances.md | 164 ++++++ docs/api/acs/access_groups/list_users.md | 222 +++++++ docs/api/acs/access_groups/remove_user.md | 123 ++++ docs/api/acs/credentials/assign.md | 123 ++++ docs/api/acs/credentials/create.md | 211 +++++++ docs/api/acs/credentials/delete.md | 114 ++++ docs/api/acs/credentials/get.md | 165 ++++++ docs/api/acs/credentials/list.md | 194 +++++++ .../credentials/list_accessible_entrances.md | 209 +++++++ docs/api/acs/credentials/unassign.md | 123 ++++ docs/api/acs/credentials/update.md | 119 ++++ docs/api/acs/encoders/encode_credential.md | 5 + docs/api/acs/encoders/list.md | 5 + docs/api/acs/encoders/scan_credential.md | 5 + .../next_credential_encode_will_fail.md | 5 + .../next_credential_encode_will_succeed.md | 5 + .../next_credential_scan_will_fail.md | 5 + .../next_credential_scan_will_succeed.md | 5 + docs/api/acs/entrances/get.md | 140 +++++ docs/api/acs/entrances/grant_access.md | 5 + docs/api/acs/entrances/list.md | 138 +++++ .../entrances/list_credentials_with_access.md | 235 ++++++++ docs/api/acs/systems/get.md | 113 ++++ docs/api/acs/systems/list.md | 115 ++++ ...mpatible_credential_manager_acs_systems.md | 119 ++++ docs/api/acs/users/add_to_access_group.md | 123 ++++ docs/api/acs/users/create.md | 549 ++++++++++++++++++ docs/api/acs/users/delete.md | 112 ++++ docs/api/acs/users/get.md | 158 +++++ docs/api/acs/users/list.md | 148 +++++ .../acs/users/list_accessible_entrances.md | 5 + .../api/acs/users/remove_from_access_group.md | 123 ++++ .../users/revoke_access_to_all_entrances.md | 5 + docs/api/acs/users/suspend.md | 112 ++++ docs/api/acs/users/unsuspend.md | 114 ++++ docs/api/acs/users/update.md | 122 ++++ docs/api/phones/deactivate.md | 5 + docs/api/phones/get.md | 5 + docs/api/phones/list.md | 5 + .../phones/simulate/create_sandbox_phone.md | 5 + .../thermostats/activate_climate_preset.md | 142 +++++ docs/api/thermostats/cool.md | 142 +++++ docs/api/thermostats/create_climate_preset.md | 152 +++++ docs/api/thermostats/delete_climate_preset.md | 121 ++++ docs/api/thermostats/heat.md | 142 +++++ docs/api/thermostats/heat_cool.md | 148 +++++ docs/api/thermostats/list.md | 223 +++++++ docs/api/thermostats/off.md | 132 +++++ docs/api/thermostats/schedules/create.md | 184 ++++++ docs/api/thermostats/schedules/delete.md | 116 ++++ docs/api/thermostats/schedules/get.md | 157 +++++ docs/api/thermostats/schedules/list.md | 210 +++++++ docs/api/thermostats/schedules/update.md | 123 ++++ .../set_fallback_climate_preset.md | 121 ++++ docs/api/thermostats/set_fan_mode.md | 142 +++++ docs/api/thermostats/set_hvac_mode.md | 153 +++++ .../thermostats/set_temperature_threshold.md | 127 ++++ .../simulate/hvac_mode_adjusted.md | 5 + .../simulate/temperature_reached.md | 5 + docs/api/thermostats/update_climate_preset.md | 132 +++++ docs/api/user_identities/add_acs_user.md | 122 ++++ docs/api/user_identities/create.md | 178 ++++++ docs/api/user_identities/delete.md | 113 ++++ .../enrollment_automations/delete.md | 118 ++++ .../enrollment_automations/get.md | 161 +++++ .../enrollment_automations/launch.md | 176 ++++++ .../enrollment_automations/list.md | 171 ++++++ docs/api/user_identities/get.md | 159 +++++ .../user_identities/grant_access_to_device.md | 122 ++++ docs/api/user_identities/list.md | 158 +++++ .../list_accessible_devices.md | 389 +++++++++++++ docs/api/user_identities/list_acs_systems.md | 176 ++++++ docs/api/user_identities/list_acs_users.md | 186 ++++++ docs/api/user_identities/remove_acs_user.md | 122 ++++ .../revoke_access_to_device.md | 122 ++++ docs/api/user_identities/update.md | 5 + 79 files changed, 9895 insertions(+) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 2c7bf69b6..1cb598c03 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Add an ACS user to an access group + +Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.addUser({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.add_user( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.AddUser( + context.Background(), + accessgroups.AccessGroupsAddUserRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e206f704c..895b39449 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -169,6 +169,7 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -189,3 +190,172 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) + +*** + +## Code Samples +### Get a specific access group + +Specify the `acs_access_group_id` of the access group that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.get({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Response + +```javascript +{ + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") +``` + +#### Response + +```python +AcsAccessGroup( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + name="Lobby Access", + display_name="Lobby Access", + access_group_type_display_name="PTI access level", + access_group_type="pti_access_level", + external_type="pti_access_level", + external_type_display_name="PTI access level", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2023-11-30T06:27:15.437Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +``` + +#### Response + +```ruby +{ + "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->get( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Response + +```php + "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Response + +```seam_cli +{ + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.Get( + context.Background(), + accessgroups.AccessGroupsGetRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Response + +```go +api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 70efeda96..8d77f25a4 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -188,6 +188,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -217,3 +218,191 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array<[acs\_access\_group](./)> + +*** + +## Code Samples +### List access groups + +To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.list({ + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Response + +```javascript +[ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.list( + acs_system_id="11111111-1111-1111-1111-111111111111", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```python +[ + AcsAccessGroup( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + name="Lobby Access", + display_name="Lobby Access", + access_group_type_display_name="PTI access level", + access_group_type="pti_access_level", + external_type="pti_access_level", + external_type_display_name="PTI access level", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2023-11-30T06:27:15.437Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.list( + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```ruby +[ + { + "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->list( + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Response + +```php + "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Response + +```seam_cli +[ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.List( + context.Background(), + accessgroups.AccessGroupsListRequest{ + AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 46e0fb964..3f16648fc 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -163,6 +163,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -183,3 +184,166 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples +### List accessible entrances for an access group + +Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.listAccessibleEntrances({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Response + +```javascript +[ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.list_accessible_entrances( + acs_access_group_id="44444444-4444-4444-4444-444444444444" +) +``` + +#### Response + +```python +[ + AcsEntrance( + acs_entrance_id="66666666-6666-6666-6666-666666666666", + name="Main Entrance", + display_name="Main Entrance", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-10-15T12:00:00.000Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.list_accessible_entrances( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +) +``` + +#### Response + +```ruby +[ + { + "acs_entrance_id" => "66666666-6666-6666-6666-666666666666", + "name" => "Main Entrance", + "display_name" => "Main Entrance", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-10-15T12:00:00.000Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->list_accessible_entrances( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Response + +```php + "66666666-6666-6666-6666-666666666666", + "name" => "Main Entrance", + "display_name" => "Main Entrance", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-10-15T12:00:00.000Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Response + +```seam_cli +[ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.ListAccessibleEntrances( + context.Background(), + accessgroups.AccessGroupsListAccessibleEntrancesRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d099bf156..fcc04c210 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -221,6 +221,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -241,3 +242,224 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array<[acs\_user](./)> + +*** + +## Code Samples +### List ACS users in an access group + +Specify the `acs_access_group_id` to retrieve all ACS users in an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.listUsers({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Response + +```javascript +[ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.list_users( + acs_access_group_id="44444444-4444-4444-4444-444444444444" +) +``` + +#### Response + +```python +[ + AcsUser( + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Jane Doe", + full_name="Jane Doe", + email="jane@example.com", + email_address="jane@example.com", + phone_number="+15555550100", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-05T07:14:28.531Z", + is_suspended=false, + access_schedule={ + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z", + }, + user_identity_id="22222222-2222-2222-2222-222222222222", + user_identity_full_name="Jane Doe", + user_identity_email_address="jane@example.com", + user_identity_phone_number="+15555550100", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +``` + +#### Response + +```ruby +[ + { + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email" => "jane@example.com", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-05T07:14:28.531Z", + "is_suspended" => false, + "access_schedule" => { + starts_at: "2024-03-01T10:40:00.000Z", + ends_at: "2024-03-04T10:40:00.000Z", + }, + "user_identity_id" => "22222222-2222-2222-2222-222222222222", + "user_identity_full_name" => "Jane Doe", + "user_identity_email_address" => "jane@example.com", + "user_identity_phone_number" => "+15555550100", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->list_users( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Response + +```php + "33333333-3333-3333-3333-333333333333", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email" => "jane@example.com", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-05T07:14:28.531Z", + "is_suspended" => false, + "access_schedule" => [ + "starts_at" => "2024-03-01T10:40:00.000Z", + "ends_at" => "2024-03-04T10:40:00.000Z", + ], + "user_identity_id" => "22222222-2222-2222-2222-222222222222", + "user_identity_full_name" => "Jane Doe", + "user_identity_email_address" => "jane@example.com", + "user_identity_phone_number" => "+15555550100", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Response + +```seam_cli +[ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.ListUsers( + context.Background(), + accessgroups.AccessGroupsListUsersRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 161a62830..6d62b1086 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Remove an ACS user from an access group + +Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.removeUser({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.remove_user( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.RemoveUser( + context.Background(), + accessgroups.AccessGroupsRemoveUserRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 53f6ed344..86e4d2907 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Assign a credential to an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.assign({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.assign( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_credential_id="66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Assign( + context.Background(), + credentials.CredentialsAssignRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index db9ddf2e3..24f92bcba 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -210,6 +210,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -320,3 +321,213 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) + +*** + +## Code Samples +### Create a credential for an ACS user + +Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.create({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z", +}); +``` + +#### Response + +```javascript +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.create( + acs_user_id="33333333-3333-3333-3333-333333333333", + access_method="mobile_key", + allowed_acs_entrance_ids=[ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential=true, + starts_at="2024-03-01T10:40:00Z", + ends_at="2024-03-04T10:40:00Z", +) +``` + +#### Response + +```python +AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="88888888-8888-8888-8888-888888888888", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.create( + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: %w[ + 55555555-5555-5555-5555-555555555555 + 55555555-5555-5555-5555-000000000000 + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z", +) +``` + +#### Response + +```ruby +{ + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "88888888-8888-8888-8888-888888888888", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->create( + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z" +); +``` + +#### Response + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "88888888-8888-8888-8888-888888888888", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" +``` + +#### Response + +```seam_cli +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Create( + context.Background(), + credentials.CredentialsCreateRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AccessMethod: api.String("mobile_key"), + AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")}, + CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), + IsMultiPhoneSyncCredential: api.Bool(true), + StartsAt: api.String("2024-03-01T10:40:00Z"), + EndsAt: api.String("2024-03-04T10:40:00Z"), + }, + ) +} +``` + +#### Response + +```go +api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 17dc00afb..30abfe8ba 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -113,6 +113,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -133,3 +134,116 @@ ID of the desired credential. ## Return Type void + +*** + +## Code Samples +### Delete a credential + +Specify the desired `acs_credential_id` to delete the specified credential. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.delete({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->delete( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Delete( + context.Background(), + credentials.CredentialsDeleteRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index d98f72ca4..8bde9999a 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -164,6 +164,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -184,3 +185,167 @@ ID of the desired credential. ## Return Type [acs\_credential](./) + +*** + +## Code Samples +### Get a credential + +Specify the `acs_credential_id` of the credential that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.get({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```python +AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="11111111-1111-1111-1111-111111111111", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```ruby +{ + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->get( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Get( + context.Background(), + credentials.CredentialsGetRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 3f9791c47..c560e2c19 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -193,6 +193,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -259,3 +260,196 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array<[acs\_credential](./)> + +*** + +## Code Samples +### List credentials + +Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.list({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true, +}); +``` + +#### Response + +```javascript +[ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.list( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_system_id="11111111-1111-1111-1111-111111111111", + user_identity_id="22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential=true, +) +``` + +#### Response + +```python +[ + AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="11111111-1111-1111-1111-111111111111", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.list( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true, +) +``` + +#### Response + +```ruby +[ + { + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->list( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true +); +``` + +#### Response + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true +``` + +#### Response + +```seam_cli +[ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.List( + context.Background(), + credentials.CredentialsListRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), + UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), + IsMultiPhoneSyncCredential: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index a77cf978d..db591cb57 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -208,6 +208,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -228,3 +229,211 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples +### List accessible entrances + +Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.listAccessibleEntrances({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +[ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.list_accessible_entrances( + acs_credential_id="66666666-6666-6666-6666-666666666666" +) +``` + +#### Response + +```python +[ + AcsEntrance( + acs_entrance_id="55555555-5555-5555-5555-555555555555", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + visionline_metadata={ + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE", + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest", + }, + latch_metadata=None, + display_name="Guest Lock 2", + created_at="2024-03-26T14:31:18.979Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.list_accessible_entrances( + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```ruby +[ + { + "acs_entrance_id" => "55555555-5555-5555-5555-555555555555", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "visionline_metadata" => { + profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }], + door_name: "Guest Lock 2", + door_category: "guest", + }, + "latch_metadata" => nil, + "display_name" => "Guest Lock 2", + "created_at" => "2024-03-26T14:31:18.979Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->list_accessible_entrances( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php + "55555555-5555-5555-5555-555555555555", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "visionline_metadata" => [ + "profiles" => [ + [ + "visionline_door_profile_id" => "Guest Door", + "visionline_door_profile_type" => "BLE", + ], + ], + "door_name" => "Guest Lock 2", + "door_category" => "guest", + ], + "latch_metadata" => null, + "display_name" => "Guest Lock 2", + "created_at" => "2024-03-26T14:31:18.979Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +[ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.ListAccessibleEntrances( + context.Background(), + credentials.CredentialsListAccessibleEntrancesRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index e7fa89f16..ad72bdeed 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Unassign a credential from an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.unassign({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.unassign( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_credential_id="66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Unassign( + context.Background(), + credentials.CredentialsUnassignRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 2d8502e70..fdeefde3f 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -118,6 +118,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -156,3 +157,121 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Return Type void + +*** + +## Code Samples +### Update a credential + +Specify the desired `acs_credential_id` and updated `code` to update the credential. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.update({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", + code: "7890", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.update( + acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->update( + acs_credential_id: "66666666-6666-6666-6666-666666666666", + code: "7890" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Update( + context.Background(), + credentials.CredentialsUpdateRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + Code: api.String("7890"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 5a6a6b23a..0cb53296e 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -69,3 +69,8 @@ Possible enum values: --- + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5705eee18..65b013eda 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -53,3 +53,8 @@ Number of `acs_encoders` to return. ## Return Type Array<[acs\_encoder](./)> + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index b84d478c2..89afb83e8 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -58,3 +58,8 @@ Possible enum values: --- + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 5f919c365..1fc31bb28 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -44,3 +44,8 @@ Code of the error to simulate. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index dd3a7fbee..8243a680d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -35,3 +35,8 @@ Scenario to simulate. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8a3333506..b73df5e5c 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -44,3 +44,8 @@ Required: No ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 92f05df53..ca507296d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -44,3 +44,8 @@ Scenario to simulate. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 3d5c4d908..395eb7118 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -139,6 +139,7 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -158,3 +159,142 @@ Required: Yes ## Return Type [acs\_entrance](./) + +*** + +## Code Samples +### Get an entrance + +Specify the `acs_entrance_id` of the entrance that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.entrances.get({ + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +{ + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +AcsEntrance( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="text", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +{ + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->entrances->get( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{ + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import entrances "github.com/seamapi/go/entrances" + +func main() { + client.Acs.Entrances.Get( + context.Background(), + entrances.EntrancesGetRequest{ + AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8ea04aa67..931f14017 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -35,3 +35,8 @@ Required: Yes ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 5d3eec62d..8d621ea4d 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -137,6 +137,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -167,3 +168,140 @@ Required: No ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples +### List entrances + +To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.entrances.list(); +``` + +#### Response + +```javascript +[ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.entrances.list() +``` + +#### Response + +```python +[ + AcsEntrance( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="text", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.entrances.list() +``` + +#### Response + +```ruby +[ + { + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->entrances->list(); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs entrances list +``` + +#### Response + +```seam_cli +[ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.Acs.Entrances.List(context.Background()) +} +``` + +#### Response + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6f96ce7fe..6dc4a8e12 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -234,6 +234,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -264,3 +265,237 @@ Required: No ## Return Type Array<[acs\_credential](./)> + +*** + +## Code Samples +### List credentials with access to an entrance + +Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.entrances.listCredentialsWithAccess({ + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +[ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.entrances.list_credentials_with_access( + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000" +) +``` + +#### Response + +```python +[ + AcsCredential( + acs_credential_id="123e4567-e89b-12d3-a456-426614174000", + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000", + display_name="text", + code="text", + card_number="text", + is_issued=false, + issued_at="2024-10-15T12:54:04.155Z", + access_method="code", + external_type="pti_card", + external_type_display_name="text", + created_at="2024-10-15T12:54:04.155Z", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + starts_at="text", + ends_at="text", + is_multi_phone_sync_credential=false, + is_latest_desired_state_synced_with_provider=false, + latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.entrances.list_credentials_with_access( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```ruby +[ + { + "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "display_name" => "text", + "code" => "text", + "card_number" => "text", + "is_issued" => false, + "issued_at" => "2024-10-15T12:54:04.155Z", + "access_method" => "code", + "external_type" => "pti_card", + "external_type_display_name" => "text", + "created_at" => "2024-10-15T12:54:04.155Z", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "starts_at" => "text", + "ends_at" => "text", + "is_multi_phone_sync_credential" => false, + "is_latest_desired_state_synced_with_provider" => false, + "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->entrances->list_credentials_with_access( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "display_name" => "text", + "code" => "text", + "card_number" => "text", + "is_issued" => false, + "issued_at" => "2024-10-15T12:54:04.155Z", + "access_method" => "code", + "external_type" => "pti_card", + "external_type_display_name" => "text", + "created_at" => "2024-10-15T12:54:04.155Z", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "starts_at" => "text", + "ends_at" => "text", + "is_multi_phone_sync_credential" => false, + "is_latest_desired_state_synced_with_provider" => false, + "latest_desired_state_synced_with_provider_at" => + "2024-10-15T12:54:04.155Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +[ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import entrances "github.com/seamapi/go/entrances" + +func main() { + client.Acs.Entrances.ListCredentialsWithAccess( + context.Background(), + entrances.EntrancesListCredentialsWithAccessRequest{ + AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 63a4959ca..6d230071b 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -114,6 +114,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -134,3 +135,115 @@ ID of the desired access control system. ## Return Type [acs\_system](./) + +*** + +## Code Samples +### Get a Specific ACS system + +Specify the `acs_system_id` of the ACS system that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.systems.get({ + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php + "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.Get( + context.Background(), + systems.SystemsGetRequest{ + AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index aade874d2..77276f01e 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -118,6 +118,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -139,3 +140,117 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array<[acs\_system](./)> + +*** + +## Code Samples +### List ACS systems by connected account + +To filter the list of ACS systems, include a `connected_account_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.systems.list({ + connected_account_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->systems->list( + connected_account_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.List( + context.Background(), + systems.SystemsListRequest{ + ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 6db41acc3..a918d9b67 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -122,6 +122,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -142,3 +143,121 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array<[acs\_system](./)> + +*** + +## Code Samples +### List compatible credential manager ACS systems + +Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.systems.list_compatible_credential_manager_acs_systems( + acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33" +) +``` + +#### Response + +```python +[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.systems.list_compatible_credential_manager_acs_systems( + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +) +``` + +#### Response + +```ruby +[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->systems->list_compatible_credential_manager_acs_systems( + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +); +``` + +#### Response + +```php + "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( + context.Background(), + systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ + AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index e1b640b59..22ba0d052 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Add an ACS user to an access group + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.addToAccessGroup({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.add_to_access_group( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.add_to_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->add_to_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.AddToAccessGroup( + context.Background(), + users.UsersAddToAccessGroupRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 5213f5e45..912003eea 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -178,6 +178,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Create a new ACS user Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. @@ -367,6 +368,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Create a new ACS user in an access group Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). @@ -544,6 +546,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -627,3 +630,549 @@ ID of the user identity with which to associate the new `acs_user`. ## Return Type [acs\_user](./) + +*** + +## Code Samples +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + access_schedule={ + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: [ + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-04T11:00:00.000Z", + ] +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + +### Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"], +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"] +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")}, + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index ae6f78535..0605b8f8b 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -111,6 +111,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -131,3 +132,114 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Delete an ACS user + +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.delete({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Delete( + context.Background(), + users.UsersDeleteRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 48b33f7b5..0a3661c38 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -157,6 +157,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -177,3 +178,160 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) + +*** + +## Code Samples +### Get a specific ACS user + +Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.get({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Get( + context.Background(), + users.UsersGetRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index f0a22d044..64e97c1a2 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -147,6 +147,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -231,3 +232,150 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array<[acs\_user](./)> + +*** + +## Code Samples +### List all ACS users + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.list(); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.list() +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.list() +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->list(); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users list +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.Acs.Users.List(context.Background()) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c5c4ad636..7d977b4b6 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -27,3 +27,8 @@ ID of the desired `acs_user`. ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples + diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index b66a08f2b..2987c3a99 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Remove an ACS user from an access group + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.removeFromAccessGroup({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.remove_from_access_group( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.remove_from_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->remove_from_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.RemoveFromAccessGroup( + context.Background(), + users.UsersRemoveFromAccessGroupRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 8a5357160..03f020b54 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -26,3 +26,8 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index e49074db2..79cda84ba 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -111,6 +111,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -131,3 +132,114 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Suspend an ACS user + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.suspend({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Suspend( + context.Background(), + users.UsersSuspendRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 8ca3d0f22..7f8bf93e7 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -113,6 +113,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -133,3 +134,116 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Unsuspend an ACS user + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.unsuspend({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->unsuspend( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Unsuspend( + context.Background(), + users.UsersUnsuspendRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 2b0b499e1..354c24786 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -195,3 +196,124 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc ## Return Type void + +*** + +## Code Samples +### Update an ACS user + +Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.update({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.update( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Update( + context.Background(), + users.UsersUpdateRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + PhoneNumber: api.String("+15555550222"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 00de709b3..ed1250399 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -27,3 +27,8 @@ Device ID of the desired phone. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 1c06ba47a..48e060396 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -26,3 +26,8 @@ Device ID of the desired phone. ## Return Type [phone](./) + +*** + +## Code Samples + diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index d0e79e40a..bfab017d9 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,3 +35,8 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array<[phone](./)> + +*** + +## Code Samples + diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index a1e393a65..ddff632a6 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -53,3 +53,8 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) + +*** + +## Code Samples + diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 958544873..f8da1445f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -202,3 +203,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Activate a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.activateClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.activate_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20", + status="pending", + action_type="ACTIVATE_CLIMATE_PRESET", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.activate_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->activate_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied" +); +``` + +#### Response + +```php + "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.ActivateClimatePreset( + context.Background(), + api.ThermostatsActivateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index cbd50743e..f7a1997a9 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -212,3 +213,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to cool mode + +Specify the desired cooling set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.cool({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.cool( + device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25 +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_COOL", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Cool( + context.Background(), + api.ThermostatsCoolRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + CoolingSetPointCelsius: api.Float64(25), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index f89b97c88..3186ba867 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -151,6 +151,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -253,3 +254,154 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void + +*** + +## Code Samples +### Create a climate preset + +Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.createClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true, +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.create_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", + climate_preset_key="occupied", + name="Occupied", + fan_mode_setting="auto", + hvac_mode_setting="heat_cool", + cooling_set_point_celsius=25, + heating_set_point_celsius=20, + manual_override_allowed=true, +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.create_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true, +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->create_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.CreateClimatePreset( + context.Background(), + api.ThermostatsCreateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + Name: api.String("Occupied"), + FanModeSetting: api.String("auto"), + HvacModeSetting: api.String("heat_cool"), + CoolingSetPointCelsius: api.Float64(25), + HeatingSetPointCelsius: api.Float64(20), + ManualOverrideAllowed: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 05dadf8a3..76b3092c2 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -120,6 +120,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,123 @@ ID of the desired thermostat device. ## Return Type void + +*** + +## Code Samples +### Delete a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.deleteClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.delete_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.DeleteClimatePreset( + context.Background(), + api.ThermostatsDeleteClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 4fec06289..9fa86fb74 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -212,3 +213,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to heat mode + +Specify the desired heating set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.heat({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.heat( + device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20 +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_HEAT", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Heat( + context.Background(), + api.ThermostatsHeatRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + HeatingSetPointCelsius: api.Float64(20), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index b1b660f81..1e2893482 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -147,6 +147,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -236,3 +237,150 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to heat-cool (auto) mode + +Specify the desired heating set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.heatCool({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.heat_cool( + device_id="123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius=25, + heating_set_point_celsius=20, +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_HEAT_COOL", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.heat_cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->heat_cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.HeatCool( + context.Background(), + api.ThermostatsHeatCoolRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + CoolingSetPointCelsius: api.Float64(25), + HeatingSetPointCelsius: api.Float64(20), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f1b56dd92..b6fa1bd64 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -222,6 +222,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -333,3 +334,225 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array<[device](./)> + +*** + +## Code Samples +### List thermostats + +To filter the list of returned thermostats, specify the desired parameters. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.list(); +``` + +#### Response + +```javascript +[ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.list() +``` + +#### Response + +```python +[ + Device( + device_id="123e4567-e89b-12d3-a456-426614174000", + device_type="ecobee_thermostat", + capabilities_supported=["thermostat"], + properties={ + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false, + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + }, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.list() +``` + +#### Response + +```ruby +[ + { + "device_id" => "123e4567-e89b-12d3-a456-426614174000", + "device_type" => "ecobee_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => { + name: "Entryway", + online: "true,", + relative_humidity: 0.36, + temperature_farenheit: 70, + available_hvac_mode_settings: %w[cool heat heat_cool off], + current_climate_setting: { + hvac_mode_setting: "heat_cool", + cooling_set_point_farenheit: 75, + heating_set_point_farenheit: 65, + manual_override_allowed: false, + }, + location: null, + connected_account_id: "123e4567-e89b-12d3-a456-426614174000", + workspace_id: "123e4567-e89b-12d3-a456-426614174000", + created_at: "2024-04-05T07:57:05.323Z", + }, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->list(); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "device_type" => "ecobee_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => [ + "name" => "Entryway", + "online" => "true,", + "relative_humidity" => 0.36, + "temperature_farenheit" => 70, + "available_hvac_mode_settings" => [ + "cool", + "heat", + "heat_cool", + "off", + ], + "current_climate_setting" => [ + "hvac_mode_setting" => "heat_cool", + "cooling_set_point_farenheit" => 75, + "heating_set_point_farenheit" => 65, + "manual_override_allowed" => false, + ], + "location" => null, + "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + ], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats list +``` + +#### Response + +```seam_cli +[ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.Thermostats.List(context.Background()) +} +``` + +#### Response + +```go +[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 143fb0841..ab5ef8d14 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -131,6 +131,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -184,3 +185,134 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to off mode + +Specify the `device_id` of the thermostat that you want to set to off mode. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.off({ + device_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_THERMOSTAT_OFF", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Off( + context.Background(), + api.ThermostatsOffRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 77b3445f7..a58997c78 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -183,6 +183,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -258,3 +259,186 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) + +*** + +## Code Samples +### Create a thermostat schedule + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.create({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90, +}); +``` + +#### Response + +```javascript +{ + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.create( + device_id="123e4567-e89b-12d3-a456-426614174000", + name="Reservation 1", + climate_preset_key="occupied", + starts_at="2024-11-01T15:00:00Z", + ends_at="2024-11-05T12:00:00Z", + max_override_period_minutes=90, +) +``` + +#### Response + +```python +ThermostatSchedule( + thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a", + name="Reservation 1", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-01T15:00:00.000Z", + ends_at="2024-11-05T12:00:00.000Z", + max_override_period_minutes=90, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.create( + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90, +) +``` + +#### Response + +```ruby +{ + "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name" => "Reservation 1", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-05T12:00:00.000Z", + "max_override_period_minutes" => 90, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->create( + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90 +); +``` + +#### Response + +```php + "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name" => "Reservation 1", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-05T12:00:00.000Z", + "max_override_period_minutes" => 90, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 +``` + +#### Response + +```seam_cli +{ + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Create( + context.Background(), + schedules.SchedulesCreateRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + Name: api.String("Reservation 1"), + ClimatePresetKey: api.String("occupied"), + StartsAt: api.String("2024-11-01T15:00:00Z"), + EndsAt: api.String("2024-11-05T12:00:00Z"), + MaxOverridePeriodMinutes: api.Float64(90), + }, + ) +} +``` + +#### Response + +```go +api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 7f7532003..4b8337d2e 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -115,6 +115,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -136,3 +137,118 @@ ID of the desired thermostat schedule. ## Return Type void + +*** + +## Code Samples +### Delete a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.delete({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.delete( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->delete( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Delete( + context.Background(), + schedules.SchedulesDeleteRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index b75581bc5..32b0c1b1a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -156,6 +156,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -177,3 +178,159 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) + +*** + +## Code Samples +### Get a specific thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.get({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", +}); +``` + +#### Response + +```javascript +{ + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.get( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" +) +``` + +#### Response + +```python +ThermostatSchedule( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + name="Reservation 2", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-10T15:00:00.000Z", + ends_at="2024-11-15T12:00:00.000Z", + max_override_period_minutes=90, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") +``` + +#### Response + +```ruby +{ + "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->get( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +); +``` + +#### Response + +```php + "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +``` + +#### Response + +```seam_cli +{ + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Get( + context.Background(), + schedules.SchedulesGetRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + }, + ) +} +``` + +#### Response + +```go +api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index ef5e66b3d..3919e321d 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -209,6 +209,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -239,3 +240,212 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array<[thermostat\_schedule](./)> + +*** + +## Code Samples +### List thermostat schedules for a thermostat + +Specify the `device_id` of the desired thermostat. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.list({ + device_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +[ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +[ + ThermostatSchedule( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + name="Reservation 2", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-10T15:00:00.000Z", + ends_at="2024-11-15T12:00:00.000Z", + max_override_period_minutes=90, + ), + ThermostatSchedule( + thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959", + name="Reservation 3", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-16T15:00:00.000Z", + ends_at="2024-11-18T12:00:00.000Z", + max_override_period_minutes=90, + ), +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +[ + { + "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, + }, + { + "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", + "name" => "Reservation 3", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-16T15:00:00.000Z", + "ends_at" => "2024-11-18T12:00:00.000Z", + "max_override_period_minutes" => 90, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->list( + device_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, + ], + [ + "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", + "name" => "Reservation 3", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-16T15:00:00.000Z", + "ends_at" => "2024-11-18T12:00:00.000Z", + "max_override_period_minutes" => 90, + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +[ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.List( + context.Background(), + schedules.SchedulesListRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 0889ea147..d981dc510 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -197,3 +198,125 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Return Type void + +*** + +## Code Samples +### Update a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.update({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.update( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at="2024-11-15T15:00:00Z", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Update( + context.Background(), + schedules.SchedulesUpdateRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + EndsAt: api.String("2024-11-15T15:00:00Z"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 24c644ebc..b2d3ae442 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -120,6 +120,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -149,3 +150,123 @@ ID of the desired thermostat device. ## Return Type void + +*** + +## Code Samples +### Set the fallback climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setFallbackClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_fallback_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetFallbackClimatePreset( + context.Background(), + api.ThermostatsSetFallbackClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("eco"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index dfa1bafc1..b7fdd5477 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -212,3 +213,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Set fan mode setting + +Specify the desired fan mode setting. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setFanMode({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto", +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_fan_mode( + device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto" +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_FAN_MODE", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_fan_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto", +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_fan_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetFanMode( + context.Background(), + api.ThermostatsSetFanModeRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FanModeSetting: api.String("auto"), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 85f530cf1..56a428823 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -152,6 +152,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -250,3 +251,155 @@ Possible enum values: --- + +*** + +## Code Samples +### Set HVAC mode + +Specify the desired heating and cooling set points in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setHvacMode({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_hvac_mode( + device_id="123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting="heat_cool", + heating_set_point_celsius=20, + cooling_set_point_celsius=25, +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="success", + action_type="SET_HVAC_MODE", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_hvac_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "success", + "action_type" => "SET_HVAC_MODE", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_hvac_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "success", + "action_type" => "SET_HVAC_MODE", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetHvacMode( + context.Background(), + api.ThermostatsSetHvacModeRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + HvacModeSetting: api.String("heat_cool"), + HeatingSetPointCelsius: api.Float64(20), + CoolingSetPointCelsius: api.Float64(25), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index e9425a28c..e6e122407 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -126,6 +126,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -182,3 +183,129 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Return Type void + +*** + +## Code Samples +### Set a temperature threshold + +Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setTemperatureThreshold({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_temperature_threshold( + device_id="123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius=4, + upper_limit_celsius=30, +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30 +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetTemperatureThreshold( + context.Background(), + api.ThermostatsSetTemperatureThresholdRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + LowerLimitCelsius: api.Float64(4), + UpperLimitCelsius: api.Float64(30), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 490f7e8a4..5d17e66bc 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -71,3 +71,8 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 467b35d50..0176847da 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -44,3 +44,8 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 186da7b28..a40dc8972 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -131,6 +131,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -233,3 +234,134 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void + +*** + +## Code Samples +### Update a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.updateClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true, +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.update_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", + climate_preset_key="occupied", + cooling_set_point_celsius=24, + manual_override_allowed=true, +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.update_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true, +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->update_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.UpdateClimatePreset( + context.Background(), + api.ThermostatsUpdateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + CoolingSetPointCelsius: api.Float64(24), + ManualOverrideAllowed: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 3edf37f08..266811c1e 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Add an ACS user to a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.addAcsUser({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.add_acs_user( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.AddAcsUser( + context.Background(), + api.UserIdentitiesAddAcsUserRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 188c9bb5a..e459f32d0 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -177,6 +177,7 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -224,3 +225,180 @@ Unique key for the user identity. ## Return Type [user\_identity](./) + +*** + +## Code Samples +### Create a user identity + +Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.create({ + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe", +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.create( + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + full_name="Jean Doe", +) +``` + +#### Response + +```python +UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.create( + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe", +) +``` + +#### Response + +```ruby +{ + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->create( + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe" +); +``` + +#### Response + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Create( + context.Background(), + api.UserIdentitiesCreateRequest{ + UserIdentityKey: api.String("jean_doe"), + EmailAddress: api.String("jean@example.com"), + PhoneNumber: api.String("+15555550110"), + FullName: api.String("Jean Doe"), + }, + ) +} +``` + +#### Response + +```go +api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 6a4fee0d4..73e69e699 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -112,6 +112,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -132,3 +133,115 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Delete a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.delete({ + user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->delete( + user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Delete( + context.Background(), + api.UserIdentitiesDeleteRequest{ + UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 36b0ce73a..3b249f382 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -117,6 +117,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -137,3 +138,120 @@ ID of the desired enrollment automation. ## Return Type void + +*** + +## Code Samples +### Delete an enrollment automation + +Specify the desired `enrollment_automation_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.delete({ + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Delete( + context.Background(), + enrollmentautomations.EnrollmentAutomationsDeleteRequest{ + EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index a5fa0ec7e..84378be83 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -160,6 +160,7 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -181,3 +182,163 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) + +*** + +## Code Samples +### Get an enrollment automation + +Specify the desired `enrollment_automation_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.get({ + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.get( + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" +) +``` + +#### Response + +```python +EnrollmentAutomation( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.get( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) +``` + +#### Response + +```ruby +{ + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->get( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" +); +``` + +#### Response + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Get( + context.Background(), + enrollmentautomations.EnrollmentAutomationsGetRequest{ + EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), + }, + ) +} +``` + +#### Response + +```go +api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 554e8e5c5..df9d748bf 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -175,6 +175,7 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -231,3 +232,178 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) + +*** + +## Code Samples +### Launch an enrollment automation + +Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.launch({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true, +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.launch( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user=true, +) +``` + +#### Response + +```python +Unknown( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.launch( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true, +) +``` + +#### Response + +```ruby +{ + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->launch( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true +); +``` + +#### Response + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Launch( + context.Background(), + enrollmentautomations.EnrollmentAutomationsLaunchRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"), + AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"), + CreateCredentialManagerUser: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 1d85c81fb..9d4a8a9db 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -170,6 +170,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -191,3 +192,173 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array<[enrollment\_automation](./)> + +*** + +## Code Samples +### List enrollment automations + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.list({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +}); +``` + +#### Response + +```javascript +[ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.list( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" +) +``` + +#### Response + +```python +[ + EnrollmentAutomation( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.list( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +) +``` + +#### Response + +```ruby +[ + { + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->list( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +); +``` + +#### Response + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +``` + +#### Response + +```seam_cli +[ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.List( + context.Background(), + enrollmentautomations.EnrollmentAutomationsListRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + }, + ) +} +``` + +#### Response + +```go +[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 8cd5b9bfb..d20d09b4e 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -158,6 +158,7 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -187,3 +188,161 @@ Required: No ## Return Type [user\_identity](./) + +*** + +## Code Samples +### Get a user identity + +Specify the `user_identity_id` of the user identity that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.get({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Response + +```python +UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Response + +```ruby +{ + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->get( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +); +``` + +#### Response + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Get( + context.Background(), + api.UserIdentitiesGetRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + }, + ) +} +``` + +#### Response + +```go +api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index a1a815225..5b4905085 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Grant a user identity access to a device + +Specify the desired `user_identity_id` and `device_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.grantAccessToDevice({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.grant_access_to_device( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id="054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.GrantAccessToDevice( + context.Background(), + api.UserIdentitiesGrantAccessToDeviceRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index a94896839..7420e0403 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -157,6 +157,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -178,3 +179,160 @@ Required: No ## Return Type Array<[user\_identity](./)> + +*** + +## Code Samples +### List user identities + +To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.list(); +``` + +#### Response + +```javascript +[ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list() +``` + +#### Response + +```python +[ + UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list() +``` + +#### Response + +```ruby +[ + { + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list(); +``` + +#### Response + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list +``` + +#### Response + +```seam_cli +[ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.UserIdentities.List(context.Background()) +} +``` + +#### Response + +```go +[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 9ac82b8ee..b5f2255ef 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -388,6 +388,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -408,3 +409,391 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array<[device](./)> + +*** + +## Code Samples +### List accessible devices for a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.listAccessibleDevices({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", +}); +``` + +#### Response + +```javascript +[ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list_accessible_devices( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf" +) +``` + +#### Response + +```python +[ + Device( + device_id="054765c8-a2fc-4599-b486-14c19f462c45", + nickname="", + display_name="Seam Thermostat", + device_type="nest_thermostat", + capabilities_supported=["thermostat"], + properties={ + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a", + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68, + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": {"name": ""}, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false, + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false, + }, + location=None, + connected_account_id="44284499-a50b-4947-86c1-58264f014be5", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-02-29T21:57:33.397Z", + errors=[], + warnings=[], + is_managed=true, + custom_metadata={}, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list_accessible_devices( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", +) +``` + +#### Response + +```ruby +[ + { + "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname" => "", + "display_name" => "Seam Thermostat", + "device_type" => "nest_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => { + online: true, + is_cooling: false, + is_heating: false, + manufacturer: "nest", + nest_metadata: { + custom_name: "", + device_name: + "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a", + }, + is_fan_running: false, + has_direct_power: true, + relative_humidity: 0.46, + temperature_celsius: 24.64, + temperature_fahrenheit: 76.352, + current_climate_setting: { + hvac_mode_setting: "heat_cool", + manual_override_allowed: true, + cooling_set_point_celsius: 21.5, + heating_set_point_celsius: 20, + cooling_set_point_fahrenheit: 70.7, + heating_set_point_fahrenheit: 68, + }, + available_hvac_mode_settings: %w[heat cool heat_cool off], + is_temporary_manual_override_active: false, + name: "", + appearance: { + name: "", + }, + model: { + display_name: "Thermostat", + manufacturer_display_name: "Nest", + accessory_keypad_supported: false, + }, + image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + image_alt_text: "Placeholder Lock Image", + is_climate_setting_schedule_active: false, + }, + "location" => nil, + "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-02-29T21:57:33.397Z", + "errors" => [], + "warnings" => [], + "is_managed" => true, + "custom_metadata" => { + }, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list_accessible_devices( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf" +); +``` + +#### Response + +```php + "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname" => "", + "display_name" => "Seam Thermostat", + "device_type" => "nest_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => [ + "online" => true, + "is_cooling" => false, + "is_heating" => false, + "manufacturer" => "nest", + "nest_metadata" => [ + "custom_name" => "", + "device_name" => + "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a", + ], + "is_fan_running" => false, + "has_direct_power" => true, + "relative_humidity" => 0.46, + "temperature_celsius" => 24.64, + "temperature_fahrenheit" => 76.352, + "current_climate_setting" => [ + "hvac_mode_setting" => "heat_cool", + "manual_override_allowed" => true, + "cooling_set_point_celsius" => 21.5, + "heating_set_point_celsius" => 20, + "cooling_set_point_fahrenheit" => 70.7, + "heating_set_point_fahrenheit" => 68, + ], + "available_hvac_mode_settings" => [ + "heat", + "cool", + "heat_cool", + "off", + ], + "is_temporary_manual_override_active" => false, + "name" => "", + "appearance" => ["name" => ""], + "model" => [ + "display_name" => "Thermostat", + "manufacturer_display_name" => "Nest", + "accessory_keypad_supported" => false, + ], + "image_url" => + "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text" => "Placeholder Lock Image", + "is_climate_setting_schedule_active" => false, + ], + "location" => null, + "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-02-29T21:57:33.397Z", + "errors" => [], + "warnings" => [], + "is_managed" => true, + "custom_metadata" => [], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" +``` + +#### Response + +```seam_cli +[ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAccessibleDevices( + context.Background(), + api.UserIdentitiesListAccessibleDevicesRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + }, + ) +} +``` + +#### Response + +```go +[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 9e3de822e..5e1fb5fdc 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -175,6 +175,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -196,3 +197,178 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array<[acs\_system](./)> + +*** + +## Code Samples +### List ACS systems associated with a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.listAcsSystems({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +}); +``` + +#### Response + +```javascript +[ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list_acs_systems( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" +) +``` + +#### Response + +```python +[ + AcsSystem( + acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + name="Assa Abloy Credential Service", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-05T07:16:51.971Z", + system_type="assa_abloy_credential_service", + system_type_display_name="Assa Abloy Credential Service", + external_type="assa_abloy_credential_service", + external_type_display_name="Assa Abloy Credential Service", + connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") +``` + +#### Response + +```ruby +[ + { + "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "name" => "Assa Abloy Credential Service", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-05T07:16:51.971Z", + "system_type" => "assa_abloy_credential_service", + "system_type_display_name" => "Assa Abloy Credential Service", + "external_type" => "assa_abloy_credential_service", + "external_type_display_name" => "Assa Abloy Credential Service", + "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list_acs_systems( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +); +``` + +#### Response + +```php + "6737e186-8d54-48ce-a7da-a0be4d252172", + "name" => "Assa Abloy Credential Service", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-05T07:16:51.971Z", + "system_type" => "assa_abloy_credential_service", + "system_type_display_name" => "Assa Abloy Credential Service", + "external_type" => "assa_abloy_credential_service", + "external_type_display_name" => "Assa Abloy Credential Service", + "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +``` + +#### Response + +```seam_cli +[ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAcsSystems( + context.Background(), + api.UserIdentitiesListAcsSystemsRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 3cc8ed5c3..a8fd57886 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -185,6 +185,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -205,3 +206,188 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array<[acs\_user](./)> + +*** + +## Code Samples +### List ACS users for a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.listAcsUsers({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", +}); +``` + +#### Response + +```javascript +[ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list_acs_users( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +) +``` + +#### Response + +```python +[ + AcsUser( + acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", + display_name="Jean Doe", + full_name="Jean Doe", + email_address="jean@example.com", + acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-11T05:45:41.349Z", + is_suspended=false, + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_email_address="jean@example.com", + user_identity_phone_number="+15555550110", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Response + +```ruby +[ + { + "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "email_address" => "jean@example.com", + "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-11T05:45:41.349Z", + "is_suspended" => false, + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address" => "jean@example.com", + "user_identity_phone_number" => "+15555550110", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list_acs_users( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +); +``` + +#### Response + +```php + "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "email_address" => "jean@example.com", + "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-11T05:45:41.349Z", + "is_suspended" => false, + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address" => "jean@example.com", + "user_identity_phone_number" => "+15555550110", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +``` + +#### Response + +```seam_cli +[ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAcsUsers( + context.Background(), + api.UserIdentitiesListAcsUsersRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index a51c702af..e9afa1459 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Remove an ACS user from a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.removeAcsUser({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.remove_acs_user( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.RemoveAcsUser( + context.Background(), + api.UserIdentitiesRemoveAcsUserRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index a1deac4cc..3b3d016ec 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Revoke access to a device from a user identity + +Specify the desired `user_identity_id` and `device_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.revokeAccessToDevice({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.revoke_access_to_device( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id="054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.RevokeAccessToDevice( + context.Background(), + api.UserIdentitiesRevokeAccessToDeviceRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d5deb5c99..619573a92 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -62,3 +62,8 @@ Unique key for the user identity. ## Return Type void + +*** + +## Code Samples + From 667f07ca2c033f5922fd154068a83dcb3735b45f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 16:04:11 -0400 Subject: [PATCH 25/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 4b6bee91f..2d5f0db9c 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -8,10 +8,6 @@ {{#if codeSamples.length}} {{#each this.codeSamples}} -## {{this.title}} - -{{this.description}} - {% tabs %} {{#each this.code}} {% tab title="{{this.title}}" %} From cd8ec0bb06192ca5fa05de164fcf9d1f0083aa71 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 20:05:12 +0000 Subject: [PATCH 26/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 4 ---- docs/api/acs/access_groups/get.md | 4 ---- docs/api/acs/access_groups/list.md | 4 ---- .../acs/access_groups/list_accessible_entrances.md | 4 ---- docs/api/acs/access_groups/list_users.md | 4 ---- docs/api/acs/access_groups/remove_user.md | 4 ---- docs/api/acs/credentials/assign.md | 4 ---- docs/api/acs/credentials/create.md | 4 ---- docs/api/acs/credentials/delete.md | 4 ---- docs/api/acs/credentials/get.md | 4 ---- docs/api/acs/credentials/list.md | 4 ---- .../api/acs/credentials/list_accessible_entrances.md | 4 ---- docs/api/acs/credentials/unassign.md | 4 ---- docs/api/acs/credentials/update.md | 4 ---- docs/api/acs/entrances/get.md | 4 ---- docs/api/acs/entrances/list.md | 4 ---- .../acs/entrances/list_credentials_with_access.md | 4 ---- docs/api/acs/systems/get.md | 4 ---- docs/api/acs/systems/list.md | 4 ---- ...list_compatible_credential_manager_acs_systems.md | 4 ---- docs/api/acs/users/add_to_access_group.md | 4 ---- docs/api/acs/users/create.md | 12 ------------ docs/api/acs/users/delete.md | 4 ---- docs/api/acs/users/get.md | 4 ---- docs/api/acs/users/list.md | 4 ---- docs/api/acs/users/remove_from_access_group.md | 4 ---- docs/api/acs/users/suspend.md | 4 ---- docs/api/acs/users/unsuspend.md | 4 ---- docs/api/acs/users/update.md | 4 ---- docs/api/thermostats/activate_climate_preset.md | 4 ---- docs/api/thermostats/cool.md | 4 ---- docs/api/thermostats/create_climate_preset.md | 4 ---- docs/api/thermostats/delete_climate_preset.md | 4 ---- docs/api/thermostats/heat.md | 4 ---- docs/api/thermostats/heat_cool.md | 4 ---- docs/api/thermostats/list.md | 4 ---- docs/api/thermostats/off.md | 4 ---- docs/api/thermostats/schedules/create.md | 4 ---- docs/api/thermostats/schedules/delete.md | 4 ---- docs/api/thermostats/schedules/get.md | 4 ---- docs/api/thermostats/schedules/list.md | 4 ---- docs/api/thermostats/schedules/update.md | 4 ---- docs/api/thermostats/set_fallback_climate_preset.md | 4 ---- docs/api/thermostats/set_fan_mode.md | 4 ---- docs/api/thermostats/set_hvac_mode.md | 4 ---- docs/api/thermostats/set_temperature_threshold.md | 4 ---- docs/api/thermostats/update_climate_preset.md | 4 ---- docs/api/user_identities/add_acs_user.md | 4 ---- docs/api/user_identities/create.md | 4 ---- docs/api/user_identities/delete.md | 4 ---- .../user_identities/enrollment_automations/delete.md | 4 ---- .../user_identities/enrollment_automations/get.md | 4 ---- .../user_identities/enrollment_automations/launch.md | 4 ---- .../user_identities/enrollment_automations/list.md | 4 ---- docs/api/user_identities/get.md | 4 ---- docs/api/user_identities/grant_access_to_device.md | 4 ---- docs/api/user_identities/list.md | 4 ---- docs/api/user_identities/list_accessible_devices.md | 4 ---- docs/api/user_identities/list_acs_systems.md | 4 ---- docs/api/user_identities/list_acs_users.md | 4 ---- docs/api/user_identities/remove_acs_user.md | 4 ---- docs/api/user_identities/revoke_access_to_device.md | 4 ---- 62 files changed, 256 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 1cb598c03..40f1a25d7 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -6,10 +6,6 @@ PUT /acs/access_groups/add_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Add an ACS user to an access group - -Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 895b39449..f33f02a98 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -6,10 +6,6 @@ POST /acs/access_groups/get ⇒ { acs_access_group } Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Get a specific access group - -Specify the `acs_access_group_id` of the access group that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 8d77f25a4..506319b03 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -6,10 +6,6 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## List access groups - -To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 3f16648fc..57f821e9c 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -6,10 +6,6 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## List accessible entrances for an access group - -Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index fcc04c210..d9b2db52c 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -6,10 +6,6 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## List ACS users in an access group - -Specify the `acs_access_group_id` to retrieve all ACS users in an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6d62b1086..6b8d2a7e0 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -6,10 +6,6 @@ POST /acs/access_groups/remove_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Remove an ACS user from an access group - -Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 86e4d2907..1bcc6e68a 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -6,10 +6,6 @@ PATCH /acs/credentials/assign ⇒ void Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Assign a credential to an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 24f92bcba..0d08bcfea 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -6,10 +6,6 @@ POST /acs/credentials/create ⇒ { acs_credential } Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Create a credential for an ACS user - -Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 30abfe8ba..00fc9422c 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -6,10 +6,6 @@ POST /acs/credentials/delete ⇒ void Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -## Delete a credential - -Specify the desired `acs_credential_id` to delete the specified credential. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 8bde9999a..d74c7a7e2 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -6,10 +6,6 @@ POST /acs/credentials/get ⇒ { acs_credential } Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -## Get a credential - -Specify the `acs_credential_id` of the credential that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index c560e2c19..dee120b2d 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -6,10 +6,6 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). -## List credentials - -Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index db591cb57..ef6602c84 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -6,10 +6,6 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. -## List accessible entrances - -Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index ad72bdeed..762bc6b27 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -6,10 +6,6 @@ PATCH /acs/credentials/unassign ⇒ void Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Unassign a credential from an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index fdeefde3f..19d51e5ce 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -6,10 +6,6 @@ PATCH /acs/credentials/update ⇒ void Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -## Update a credential - -Specify the desired `acs_credential_id` and updated `code` to update the credential. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 395eb7118..d05f0b15c 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -6,10 +6,6 @@ POST /acs/entrances/get ⇒ { acs_entrance } Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -## Get an entrance - -Specify the `acs_entrance_id` of the entrance that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 8d621ea4d..214fc6a23 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -6,10 +6,6 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). -## List entrances - -To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6dc4a8e12..054919f21 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -6,10 +6,6 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -## List credentials with access to an entrance - -Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 6d230071b..d450d72fd 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -8,10 +8,6 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. -## Get a Specific ACS system - -Specify the `acs_system_id` of the ACS system that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 77276f01e..8db999568 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -10,10 +10,6 @@ To filter the list of returned access control systems by a specific connected ac `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. -## List ACS systems by connected account - -To filter the list of ACS systems, include a `connected_account_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index a918d9b67..bb716ce5a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -10,10 +10,6 @@ Returns a list of all credential manager ACS systems that are compatible with a Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. -## List compatible credential manager ACS systems - -Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 22ba0d052..9bcb241b1 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -6,10 +6,6 @@ PUT /acs/users/add_to_access_group ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Add an ACS user to an access group - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 912003eea..30a637157 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -6,10 +6,6 @@ POST /acs/users/create ⇒ { acs_user } Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - {% tabs %} {% tab title="JavaScript" %} #### Request @@ -179,10 +175,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request @@ -369,10 +361,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Create a new ACS user in an access group - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 0605b8f8b..9917670cc 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -6,10 +6,6 @@ POST /acs/users/delete ⇒ void Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). -## Delete an ACS user - -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 0a3661c38..12ab83e39 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -6,10 +6,6 @@ POST /acs/users/get ⇒ { acs_user } Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Get a specific ACS user - -Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 64e97c1a2..5e6693d69 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -6,10 +6,6 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## List all ACS users - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 2987c3a99..364a86040 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -6,10 +6,6 @@ POST /acs/users/remove_from_access_group ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Remove an ACS user from an access group - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 79cda84ba..e97251386 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -6,10 +6,6 @@ POST /acs/users/suspend ⇒ void [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. -## Suspend an ACS user - -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 7f8bf93e7..7e0adb646 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -6,10 +6,6 @@ POST /acs/users/unsuspend ⇒ void [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. -## Unsuspend an ACS user - -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 354c24786..0bee5cc50 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -6,10 +6,6 @@ PATCH /acs/users/update ⇒ void Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Update an ACS user - -Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index f8da1445f..5c8997a42 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Activate a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index f7a1997a9..8c2eecb37 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -6,10 +6,6 @@ POST /thermostats/cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to cool mode - -Specify the desired cooling set point in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 3186ba867..b36396fb5 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/create_climate_preset ⇒ void Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Create a climate preset - -Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 76b3092c2..df31db85a 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/delete_climate_preset ⇒ void Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Delete a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 9fa86fb74..b11967e9d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -6,10 +6,6 @@ POST /thermostats/heat ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to heat mode - -Specify the desired heating set point in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 1e2893482..b78365c3e 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -6,10 +6,6 @@ POST /thermostats/heat_cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to heat-cool (auto) mode - -Specify the desired heating set point in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index b6fa1bd64..cf3336306 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -6,10 +6,6 @@ POST /thermostats/list ⇒ { devices: [device, …] } Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). -## List thermostats - -To filter the list of returned thermostats, specify the desired parameters. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index ab5ef8d14..25108600a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -6,10 +6,6 @@ POST /thermostats/off ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to off mode - -Specify the `device_id` of the thermostat that you want to set to off mode. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index a58997c78..40cdd6e4f 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Create a thermostat schedule - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 4b8337d2e..52fa56149 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/delete ⇒ void Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Delete a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 32b0c1b1a..1cb2eff7c 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -## Get a specific thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3919e321d..8bc2bd352 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## List thermostat schedules for a thermostat - -Specify the `device_id` of the desired thermostat. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index d981dc510..71697435e 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -6,10 +6,6 @@ PATCH /thermostats/schedules/update ⇒ void Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -## Update a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index b2d3ae442..780307793 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/set_fallback_climate_preset ⇒ void Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Set the fallback climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index b7fdd5477..c5fc81c86 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -6,10 +6,6 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Set fan mode setting - -Specify the desired fan mode setting. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 56a428823..0e102e92e 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -6,10 +6,6 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Set HVAC mode - -Specify the desired heating and cooling set points in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index e6e122407..0590a0ba1 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -6,10 +6,6 @@ PATCH /thermostats/set_temperature_threshold ⇒ void Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. -## Set a temperature threshold - -Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index a40dc8972..b00c2bf55 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -6,10 +6,6 @@ PATCH /thermostats/update_climate_preset ⇒ void Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Update a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 266811c1e..299d79f08 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -6,10 +6,6 @@ PUT /user_identities/add_acs_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Add an ACS user to a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index e459f32d0..8d95a69a3 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -6,10 +6,6 @@ POST /user_identities/create ⇒ { user_identity } Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Create a user identity - -Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 73e69e699..5cd1d2ae6 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -6,10 +6,6 @@ POST /user_identities/delete ⇒ void Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. -## Delete a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 3b249f382..0fa34d659 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/delete ⇒ void Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). -## Delete an enrollment automation - -Specify the desired `enrollment_automation_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 84378be83..e1ca50c85 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -## Get an enrollment automation - -Specify the desired `enrollment_automation_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index df9d748bf..694ceec93 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -## Launch an enrollment automation - -Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 9d4a8a9db..24f3a00cc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List enrollment automations - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index d20d09b4e..6a167fe05 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -6,10 +6,6 @@ POST /user_identities/get ⇒ { user_identity } Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Get a user identity - -Specify the `user_identity_id` of the user identity that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 5b4905085..a9d9be01e 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -6,10 +6,6 @@ PUT /user_identities/grant_access_to_device ⇒ void Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). -## Grant a user identity access to a device - -Specify the desired `user_identity_id` and `device_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7420e0403..f6c16069d 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -6,10 +6,6 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List user identities - -To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index b5f2255ef..25ab353ef 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -6,10 +6,6 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List accessible devices for a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 5e1fb5fdc..ab7e02076 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -6,10 +6,6 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List ACS systems associated with a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index a8fd57886..aedc13092 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -6,10 +6,6 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List ACS users for a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e9afa1459..e395588e7 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -6,10 +6,6 @@ POST /user_identities/remove_acs_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Remove an ACS user from a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 3b3d016ec..0ef025d83 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -6,10 +6,6 @@ POST /user_identities/revoke_access_to_device ⇒ void Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Revoke access to a device from a user identity - -Specify the desired `user_identity_id` and `device_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request From 028b008873ea9d93db880e0144fbed5381b26159 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 19:45:09 +0000 Subject: [PATCH 27/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 122 ---- docs/api/acs/access_groups/get.md | 169 ------ docs/api/acs/access_groups/list.md | 188 ------ .../list_accessible_entrances.md | 163 ------ docs/api/acs/access_groups/list_users.md | 221 ------- docs/api/acs/access_groups/remove_user.md | 122 ---- docs/api/acs/credentials/assign.md | 122 ---- docs/api/acs/credentials/create.md | 210 ------- docs/api/acs/credentials/delete.md | 113 ---- docs/api/acs/credentials/get.md | 164 ------ docs/api/acs/credentials/list.md | 193 ------ .../credentials/list_accessible_entrances.md | 208 ------- docs/api/acs/credentials/unassign.md | 122 ---- docs/api/acs/credentials/update.md | 118 ---- docs/api/acs/encoders/encode_credential.md | 5 - docs/api/acs/encoders/list.md | 5 - docs/api/acs/encoders/scan_credential.md | 5 - .../next_credential_encode_will_fail.md | 5 - .../next_credential_encode_will_succeed.md | 5 - .../next_credential_scan_will_fail.md | 5 - .../next_credential_scan_will_succeed.md | 5 - docs/api/acs/entrances/get.md | 139 ----- docs/api/acs/entrances/grant_access.md | 5 - docs/api/acs/entrances/list.md | 137 ----- .../entrances/list_credentials_with_access.md | 234 -------- docs/api/acs/systems/get.md | 112 ---- docs/api/acs/systems/list.md | 114 ---- ...mpatible_credential_manager_acs_systems.md | 118 ---- docs/api/acs/users/add_to_access_group.md | 122 ---- docs/api/acs/users/create.md | 547 +----------------- docs/api/acs/users/delete.md | 111 ---- docs/api/acs/users/get.md | 157 ----- docs/api/acs/users/list.md | 147 ----- .../acs/users/list_accessible_entrances.md | 5 - .../api/acs/users/remove_from_access_group.md | 122 ---- .../users/revoke_access_to_all_entrances.md | 5 - docs/api/acs/users/suspend.md | 111 ---- docs/api/acs/users/unsuspend.md | 113 ---- docs/api/acs/users/update.md | 121 ---- docs/api/phones/deactivate.md | 5 - docs/api/phones/get.md | 5 - docs/api/phones/list.md | 5 - .../phones/simulate/create_sandbox_phone.md | 5 - .../thermostats/activate_climate_preset.md | 141 ----- docs/api/thermostats/cool.md | 141 ----- docs/api/thermostats/create_climate_preset.md | 151 ----- docs/api/thermostats/delete_climate_preset.md | 120 ---- docs/api/thermostats/heat.md | 141 ----- docs/api/thermostats/heat_cool.md | 147 ----- docs/api/thermostats/list.md | 222 ------- docs/api/thermostats/off.md | 131 ----- docs/api/thermostats/schedules/create.md | 183 ------ docs/api/thermostats/schedules/delete.md | 115 ---- docs/api/thermostats/schedules/get.md | 156 ----- docs/api/thermostats/schedules/list.md | 209 ------- docs/api/thermostats/schedules/update.md | 122 ---- .../set_fallback_climate_preset.md | 120 ---- docs/api/thermostats/set_fan_mode.md | 141 ----- docs/api/thermostats/set_hvac_mode.md | 152 ----- .../thermostats/set_temperature_threshold.md | 126 ---- .../simulate/hvac_mode_adjusted.md | 5 - .../simulate/temperature_reached.md | 5 - docs/api/thermostats/update_climate_preset.md | 131 ----- docs/api/user_identities/add_acs_user.md | 121 ---- docs/api/user_identities/create.md | 177 ------ docs/api/user_identities/delete.md | 112 ---- .../enrollment_automations/delete.md | 117 ---- .../enrollment_automations/get.md | 160 ----- .../enrollment_automations/launch.md | 175 ------ .../enrollment_automations/list.md | 170 ------ docs/api/user_identities/get.md | 158 ----- .../user_identities/grant_access_to_device.md | 121 ---- docs/api/user_identities/list.md | 157 ----- .../list_accessible_devices.md | 388 ------------- docs/api/user_identities/list_acs_systems.md | 175 ------ docs/api/user_identities/list_acs_users.md | 185 ------ docs/api/user_identities/remove_acs_user.md | 121 ---- .../revoke_access_to_device.md | 121 ---- docs/api/user_identities/update.md | 5 - 79 files changed, 1 insertion(+), 9831 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 40f1a25d7..983d05410 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Add an ACS user to an access group - -Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.addUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.add_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.AddUser( - context.Background(), - accessgroups.AccessGroupsAddUserRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index f33f02a98..e33a8cb19 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -186,172 +186,3 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) - -*** - -## Code Samples -### Get a specific access group - -Specify the `acs_access_group_id` of the access group that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.get({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Response - -```javascript -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") -``` - -#### Response - -```python -AcsAccessGroup( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - name="Lobby Access", - display_name="Lobby Access", - access_group_type_display_name="PTI access level", - access_group_type="pti_access_level", - external_type="pti_access_level", - external_type_display_name="PTI access level", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2023-11-30T06:27:15.437Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") -``` - -#### Response - -```ruby -{ - "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->get( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Response - -```php - "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Response - -```seam_cli -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.Get( - context.Background(), - accessgroups.AccessGroupsGetRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Response - -```go -api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 506319b03..103b790ba 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -214,191 +214,3 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array<[acs\_access\_group](./)> - -*** - -## Code Samples -### List access groups - -To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.list({ - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Response - -```javascript -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.list( - acs_system_id="11111111-1111-1111-1111-111111111111", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```python -[ - AcsAccessGroup( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - name="Lobby Access", - display_name="Lobby Access", - access_group_type_display_name="PTI access level", - access_group_type="pti_access_level", - external_type="pti_access_level", - external_type_display_name="PTI access level", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2023-11-30T06:27:15.437Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```ruby -[ - { - "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Response - -```php - "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Response - -```seam_cli -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.List( - context.Background(), - accessgroups.AccessGroupsListRequest{ - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 57f821e9c..265ab76d3 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -180,166 +180,3 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples -### List accessible entrances for an access group - -Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.listAccessibleEntrances({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Response - -```javascript -[ - { - "acs_entrance_id": "66666666-6666-6666-6666-666666666666", - "name": "Main Entrance", - "display_name": "Main Entrance", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-10-15T12:00:00.000Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.list_accessible_entrances( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` - -#### Response - -```python -[ - AcsEntrance( - acs_entrance_id="66666666-6666-6666-6666-666666666666", - name="Main Entrance", - display_name="Main Entrance", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-10-15T12:00:00.000Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.list_accessible_entrances( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -) -``` - -#### Response - -```ruby -[ - { - "acs_entrance_id" => "66666666-6666-6666-6666-666666666666", - "name" => "Main Entrance", - "display_name" => "Main Entrance", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-10-15T12:00:00.000Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->list_accessible_entrances( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Response - -```php - "66666666-6666-6666-6666-666666666666", - "name" => "Main Entrance", - "display_name" => "Main Entrance", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-10-15T12:00:00.000Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Response - -```seam_cli -[ - { - "acs_entrance_id": "66666666-6666-6666-6666-666666666666", - "name": "Main Entrance", - "display_name": "Main Entrance", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-10-15T12:00:00.000Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.ListAccessibleEntrances( - context.Background(), - accessgroups.AccessGroupsListAccessibleEntrancesRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d9b2db52c..c366a94a6 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -238,224 +238,3 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array<[acs\_user](./)> - -*** - -## Code Samples -### List ACS users in an access group - -Specify the `acs_access_group_id` to retrieve all ACS users in an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.listUsers({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Response - -```javascript -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.list_users( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` - -#### Response - -```python -[ - AcsUser( - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Jane Doe", - full_name="Jane Doe", - email="jane@example.com", - email_address="jane@example.com", - phone_number="+15555550100", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-05T07:14:28.531Z", - is_suspended=false, - access_schedule={ - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z", - }, - user_identity_id="22222222-2222-2222-2222-222222222222", - user_identity_full_name="Jane Doe", - user_identity_email_address="jane@example.com", - user_identity_phone_number="+15555550100", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") -``` - -#### Response - -```ruby -[ - { - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email" => "jane@example.com", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-05T07:14:28.531Z", - "is_suspended" => false, - "access_schedule" => { - starts_at: "2024-03-01T10:40:00.000Z", - ends_at: "2024-03-04T10:40:00.000Z", - }, - "user_identity_id" => "22222222-2222-2222-2222-222222222222", - "user_identity_full_name" => "Jane Doe", - "user_identity_email_address" => "jane@example.com", - "user_identity_phone_number" => "+15555550100", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->list_users( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Response - -```php - "33333333-3333-3333-3333-333333333333", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email" => "jane@example.com", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-05T07:14:28.531Z", - "is_suspended" => false, - "access_schedule" => [ - "starts_at" => "2024-03-01T10:40:00.000Z", - "ends_at" => "2024-03-04T10:40:00.000Z", - ], - "user_identity_id" => "22222222-2222-2222-2222-222222222222", - "user_identity_full_name" => "Jane Doe", - "user_identity_email_address" => "jane@example.com", - "user_identity_phone_number" => "+15555550100", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Response - -```seam_cli -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.ListUsers( - context.Background(), - accessgroups.AccessGroupsListUsersRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6b8d2a7e0..6902f8394 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Remove an ACS user from an access group - -Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.removeUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.remove_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.RemoveUser( - context.Background(), - accessgroups.AccessGroupsRemoveUserRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 1bcc6e68a..e1cae31f5 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Assign a credential to an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.assign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.assign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Assign( - context.Background(), - credentials.CredentialsAssignRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 0d08bcfea..af1e25bfe 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -317,213 +317,3 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) - -*** - -## Code Samples -### Create a credential for an ACS user - -Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.create({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", -}); -``` - -#### Response - -```javascript -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.create( - acs_user_id="33333333-3333-3333-3333-333333333333", - access_method="mobile_key", - allowed_acs_entrance_ids=[ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential=true, - starts_at="2024-03-01T10:40:00Z", - ends_at="2024-03-04T10:40:00Z", -) -``` - -#### Response - -```python -AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="88888888-8888-8888-8888-888888888888", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: %w[ - 55555555-5555-5555-5555-555555555555 - 55555555-5555-5555-5555-000000000000 - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", -) -``` - -#### Response - -```ruby -{ - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "88888888-8888-8888-8888-888888888888", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z" -); -``` - -#### Response - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "88888888-8888-8888-8888-888888888888", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" -``` - -#### Response - -```seam_cli -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Create( - context.Background(), - credentials.CredentialsCreateRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AccessMethod: api.String("mobile_key"), - AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")}, - CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), - IsMultiPhoneSyncCredential: api.Bool(true), - StartsAt: api.String("2024-03-01T10:40:00Z"), - EndsAt: api.String("2024-03-04T10:40:00Z"), - }, - ) -} -``` - -#### Response - -```go -api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 00fc9422c..9a0fee13f 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -130,116 +130,3 @@ ID of the desired credential. ## Return Type void - -*** - -## Code Samples -### Delete a credential - -Specify the desired `acs_credential_id` to delete the specified credential. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.delete({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->delete( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Delete( - context.Background(), - credentials.CredentialsDeleteRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index d74c7a7e2..649794cee 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -181,167 +181,3 @@ ID of the desired credential. ## Return Type [acs\_credential](./) - -*** - -## Code Samples -### Get a credential - -Specify the `acs_credential_id` of the credential that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.get({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```python -AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="11111111-1111-1111-1111-111111111111", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```ruby -{ - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->get( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Get( - context.Background(), - credentials.CredentialsGetRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index dee120b2d..2f656b113 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -256,196 +256,3 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array<[acs\_credential](./)> - -*** - -## Code Samples -### List credentials - -Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.list({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true, -}); -``` - -#### Response - -```javascript -[ - { - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.list( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_system_id="11111111-1111-1111-1111-111111111111", - user_identity_id="22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential=true, -) -``` - -#### Response - -```python -[ - AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="11111111-1111-1111-1111-111111111111", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.list( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true, -) -``` - -#### Response - -```ruby -[ - { - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->list( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true -); -``` - -#### Response - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true -``` - -#### Response - -```seam_cli -[ - { - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.List( - context.Background(), - credentials.CredentialsListRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), - IsMultiPhoneSyncCredential: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index ef6602c84..3dddcd871 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -225,211 +225,3 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples -### List accessible entrances - -Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.listAccessibleEntrances({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.list_accessible_entrances( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` - -#### Response - -```python -[ - AcsEntrance( - acs_entrance_id="55555555-5555-5555-5555-555555555555", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - visionline_metadata={ - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE", - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest", - }, - latch_metadata=None, - display_name="Guest Lock 2", - created_at="2024-03-26T14:31:18.979Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```ruby -[ - { - "acs_entrance_id" => "55555555-5555-5555-5555-555555555555", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "visionline_metadata" => { - profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }], - door_name: "Guest Lock 2", - door_category: "guest", - }, - "latch_metadata" => nil, - "display_name" => "Guest Lock 2", - "created_at" => "2024-03-26T14:31:18.979Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php - "55555555-5555-5555-5555-555555555555", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "visionline_metadata" => [ - "profiles" => [ - [ - "visionline_door_profile_id" => "Guest Door", - "visionline_door_profile_type" => "BLE", - ], - ], - "door_name" => "Guest Lock 2", - "door_category" => "guest", - ], - "latch_metadata" => null, - "display_name" => "Guest Lock 2", - "created_at" => "2024-03-26T14:31:18.979Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.ListAccessibleEntrances( - context.Background(), - credentials.CredentialsListAccessibleEntrancesRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 762bc6b27..187a30eb3 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Unassign a credential from an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.unassign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.unassign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.unassign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->unassign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Unassign( - context.Background(), - credentials.CredentialsUnassignRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 19d51e5ce..549c4a2b5 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -153,121 +153,3 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Return Type void - -*** - -## Code Samples -### Update a credential - -Specify the desired `acs_credential_id` and updated `code` to update the credential. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.update({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.update( - acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->update( - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Update( - context.Background(), - credentials.CredentialsUpdateRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - Code: api.String("7890"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 0cb53296e..5a6a6b23a 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -69,8 +69,3 @@ Possible enum values: --- - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 65b013eda..5705eee18 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -53,8 +53,3 @@ Number of `acs_encoders` to return. ## Return Type Array<[acs\_encoder](./)> - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 89afb83e8..b84d478c2 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -58,8 +58,3 @@ Possible enum values: --- - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 1fc31bb28..5f919c365 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -44,8 +44,3 @@ Code of the error to simulate. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 8243a680d..dd3a7fbee 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -35,8 +35,3 @@ Scenario to simulate. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index b73df5e5c..8a3333506 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -44,8 +44,3 @@ Required: No ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index ca507296d..92f05df53 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -44,8 +44,3 @@ Scenario to simulate. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index d05f0b15c..b4bbbbdf4 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -155,142 +155,3 @@ Required: Yes ## Return Type [acs\_entrance](./) - -*** - -## Code Samples -### Get an entrance - -Specify the `acs_entrance_id` of the entrance that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.entrances.get({ - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -{ - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -AcsEntrance( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="text", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -{ - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->entrances->get( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{ - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import entrances "github.com/seamapi/go/entrances" - -func main() { - client.Acs.Entrances.Get( - context.Background(), - entrances.EntrancesGetRequest{ - AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 931f14017..8ea04aa67 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -35,8 +35,3 @@ Required: Yes ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 214fc6a23..acf540d23 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -164,140 +164,3 @@ Required: No ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples -### List entrances - -To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.entrances.list(); -``` - -#### Response - -```javascript -[ - { - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.entrances.list() -``` - -#### Response - -```python -[ - AcsEntrance( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="text", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.entrances.list() -``` - -#### Response - -```ruby -[ - { - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->entrances->list(); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs entrances list -``` - -#### Response - -```seam_cli -[ - { - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.Acs.Entrances.List(context.Background()) -} -``` - -#### Response - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 054919f21..6cd85a7bf 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -261,237 +261,3 @@ Required: No ## Return Type Array<[acs\_credential](./)> - -*** - -## Code Samples -### List credentials with access to an entrance - -Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.entrances.listCredentialsWithAccess({ - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -[ - { - "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "display_name": "text", - "code": "text", - "card_number": "text", - "is_issued": false, - "issued_at": "2024-10-15T12:54:04.155Z", - "access_method": "code", - "external_type": "pti_card", - "external_type_display_name": "text", - "created_at": "2024-10-15T12:54:04.155Z", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "starts_at": "text", - "ends_at": "text", - "is_multi_phone_sync_credential": false, - "is_latest_desired_state_synced_with_provider": false, - "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000" -) -``` - -#### Response - -```python -[ - AcsCredential( - acs_credential_id="123e4567-e89b-12d3-a456-426614174000", - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000", - display_name="text", - code="text", - card_number="text", - is_issued=false, - issued_at="2024-10-15T12:54:04.155Z", - access_method="code", - external_type="pti_card", - external_type_display_name="text", - created_at="2024-10-15T12:54:04.155Z", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - starts_at="text", - ends_at="text", - is_multi_phone_sync_credential=false, - is_latest_desired_state_synced_with_provider=false, - latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```ruby -[ - { - "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "display_name" => "text", - "code" => "text", - "card_number" => "text", - "is_issued" => false, - "issued_at" => "2024-10-15T12:54:04.155Z", - "access_method" => "code", - "external_type" => "pti_card", - "external_type_display_name" => "text", - "created_at" => "2024-10-15T12:54:04.155Z", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "starts_at" => "text", - "ends_at" => "text", - "is_multi_phone_sync_credential" => false, - "is_latest_desired_state_synced_with_provider" => false, - "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->entrances->list_credentials_with_access( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "display_name" => "text", - "code" => "text", - "card_number" => "text", - "is_issued" => false, - "issued_at" => "2024-10-15T12:54:04.155Z", - "access_method" => "code", - "external_type" => "pti_card", - "external_type_display_name" => "text", - "created_at" => "2024-10-15T12:54:04.155Z", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "starts_at" => "text", - "ends_at" => "text", - "is_multi_phone_sync_credential" => false, - "is_latest_desired_state_synced_with_provider" => false, - "latest_desired_state_synced_with_provider_at" => - "2024-10-15T12:54:04.155Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -[ - { - "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "display_name": "text", - "code": "text", - "card_number": "text", - "is_issued": false, - "issued_at": "2024-10-15T12:54:04.155Z", - "access_method": "code", - "external_type": "pti_card", - "external_type_display_name": "text", - "created_at": "2024-10-15T12:54:04.155Z", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "starts_at": "text", - "ends_at": "text", - "is_multi_phone_sync_credential": false, - "is_latest_desired_state_synced_with_provider": false, - "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import entrances "github.com/seamapi/go/entrances" - -func main() { - client.Acs.Entrances.ListCredentialsWithAccess( - context.Background(), - entrances.EntrancesListCredentialsWithAccessRequest{ - AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index d450d72fd..a4c54c150 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -131,115 +131,3 @@ ID of the desired access control system. ## Return Type [acs\_system](./) - -*** - -## Code Samples -### Get a Specific ACS system - -Specify the `acs_system_id` of the ACS system that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.systems.get({ - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php - "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.Get( - context.Background(), - systems.SystemsGetRequest{ - AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 8db999568..61766cfe3 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -136,117 +136,3 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array<[acs\_system](./)> - -*** - -## Code Samples -### List ACS systems by connected account - -To filter the list of ACS systems, include a `connected_account_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.systems.list({ - connected_account_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->systems->list( - connected_account_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.List( - context.Background(), - systems.SystemsListRequest{ - ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index bb716ce5a..64204002a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -139,121 +139,3 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array<[acs\_system](./)> - -*** - -## Code Samples -### List compatible credential manager ACS systems - -Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33" -) -``` - -#### Response - -```python -[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -) -``` - -#### Response - -```ruby -[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->systems->list_compatible_credential_manager_acs_systems( - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -); -``` - -#### Response - -```php - "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( - context.Background(), - systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ - AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 9bcb241b1..220fea9d0 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -148,125 +148,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Add an ACS user to an access group - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.addToAccessGroup({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.add_to_access_group( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.add_to_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->add_to_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.AddToAccessGroup( - context.Background(), - users.UsersAddToAccessGroupRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 30a637157..01ba1da82 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -175,366 +175,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.create({ - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: { - starts_at: "2024-11-01T15:00:00.000Z", - ends_at: "2024-11-04T11:00:00.000Z", - }, -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.create( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", - access_schedule={ - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-04T11:00:00.000Z", - }, -) -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: { - starts_at: "2024-11-01T15:00:00.000Z", - ends_at: "2024-11-04T11:00:00.000Z", - }, -) -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: [ - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-04T11:00:00.000Z", - ] -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Create( - context.Background(), - users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.create({ - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.create( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", - acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"], -) -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], -) -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"] -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Create( - context.Background(), - users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")}, - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - ## Authentication Methods - API key @@ -619,185 +259,7 @@ ID of the user identity with which to associate the new `acs_user`. [acs\_user](./) -*** - -## Code Samples -### Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.create({ - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.create( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", -) -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Create( - context.Background(), - users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - -### Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. +## Additional Code Samples {% tabs %} {% tab title="JavaScript" %} @@ -984,11 +446,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - -### Create a new ACS user in an access group - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). - {% tabs %} {% tab title="JavaScript" %} #### Request @@ -1162,5 +619,3 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - - diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 9917670cc..fcae60e5b 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -128,114 +128,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Delete an ACS user - -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.delete({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Delete( - context.Background(), - users.UsersDeleteRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 12ab83e39..997149da3 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -174,160 +174,3 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) - -*** - -## Code Samples -### Get a specific ACS user - -Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.get({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Get( - context.Background(), - users.UsersGetRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 5e6693d69..b23c5a49e 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -228,150 +228,3 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array<[acs\_user](./)> - -*** - -## Code Samples -### List all ACS users - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.list(); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.list() -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.list() -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->list(); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users list -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.Acs.Users.List(context.Background()) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 7d977b4b6..c5c4ad636 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -27,8 +27,3 @@ ID of the desired `acs_user`. ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples - diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 364a86040..7a5808809 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -148,125 +148,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Remove an ACS user from an access group - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.removeFromAccessGroup({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.remove_from_access_group( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.remove_from_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->remove_from_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.RemoveFromAccessGroup( - context.Background(), - users.UsersRemoveFromAccessGroupRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 03f020b54..8a5357160 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -26,8 +26,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index e97251386..3e7988c69 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -128,114 +128,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Suspend an ACS user - -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.suspend({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Suspend( - context.Background(), - users.UsersSuspendRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 7e0adb646..e2f624dd0 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -130,116 +130,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Unsuspend an ACS user - -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.unsuspend({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->unsuspend( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Unsuspend( - context.Background(), - users.UsersUnsuspendRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 0bee5cc50..dccb7c8af 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -192,124 +192,3 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc ## Return Type void - -*** - -## Code Samples -### Update an ACS user - -Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.update({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.update( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.update( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->update( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Update( - context.Background(), - users.UsersUpdateRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - PhoneNumber: api.String("+15555550222"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index ed1250399..00de709b3 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -27,8 +27,3 @@ Device ID of the desired phone. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 48e060396..1c06ba47a 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -26,8 +26,3 @@ Device ID of the desired phone. ## Return Type [phone](./) - -*** - -## Code Samples - diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index bfab017d9..d0e79e40a 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,8 +35,3 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array<[phone](./)> - -*** - -## Code Samples - diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index ddff632a6..a1e393a65 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -53,8 +53,3 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) - -*** - -## Code Samples - diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5c8997a42..2f654e1d3 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -199,144 +199,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Activate a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.activateClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", - "status": "pending", - "action_type": "ACTIVATE_CLIMATE_PRESET" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.activate_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20", - status="pending", - action_type="ACTIVATE_CLIMATE_PRESET", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.activate_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", - "status" => "pending", - "action_type" => "ACTIVATE_CLIMATE_PRESET", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->activate_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied" -); -``` - -#### Response - -```php - "05de2295-d1dc-4748-aae3-9931658bde20", - "status" => "pending", - "action_type" => "ACTIVATE_CLIMATE_PRESET", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", - "status": "pending", - "action_type": "ACTIVATE_CLIMATE_PRESET" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.ActivateClimatePreset( - context.Background(), - api.ThermostatsActivateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 8c2eecb37..9794da83a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -209,144 +209,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to cool mode - -Specify the desired cooling set point in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.cool({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_COOL" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.cool( - device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25 -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_COOL", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_COOL", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_COOL", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_COOL" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Cool( - context.Background(), - api.ThermostatsCoolRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - CoolingSetPointCelsius: api.Float64(25), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index b36396fb5..069c4b3c5 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -250,154 +250,3 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void - -*** - -## Code Samples -### Create a climate preset - -Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.createClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true, -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.create_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", - climate_preset_key="occupied", - name="Occupied", - fan_mode_setting="auto", - hvac_mode_setting="heat_cool", - cooling_set_point_celsius=25, - heating_set_point_celsius=20, - manual_override_allowed=true, -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.create_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true, -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->create_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.CreateClimatePreset( - context.Background(), - api.ThermostatsCreateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - Name: api.String("Occupied"), - FanModeSetting: api.String("auto"), - HvacModeSetting: api.String("heat_cool"), - CoolingSetPointCelsius: api.Float64(25), - HeatingSetPointCelsius: api.Float64(20), - ManualOverrideAllowed: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index df31db85a..570123781 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -147,123 +147,3 @@ ID of the desired thermostat device. ## Return Type void - -*** - -## Code Samples -### Delete a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.deleteClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.delete_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.delete_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->delete_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.DeleteClimatePreset( - context.Background(), - api.ThermostatsDeleteClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index b11967e9d..bb1189645 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -209,144 +209,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to heat mode - -Specify the desired heating set point in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.heat({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.heat( - device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20 -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_HEAT", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.heat( - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->heat( - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Heat( - context.Background(), - api.ThermostatsHeatRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - HeatingSetPointCelsius: api.Float64(20), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index b78365c3e..e29392489 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -233,150 +233,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to heat-cool (auto) mode - -Specify the desired heating set point in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.heatCool({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT_COOL" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.heat_cool( - device_id="123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius=25, - heating_set_point_celsius=20, -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_HEAT_COOL", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.heat_cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT_COOL", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->heat_cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT_COOL", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT_COOL" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.HeatCool( - context.Background(), - api.ThermostatsHeatCoolRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - CoolingSetPointCelsius: api.Float64(25), - HeatingSetPointCelsius: api.Float64(20), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index cf3336306..f0adedbe6 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -330,225 +330,3 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array<[device](./)> - -*** - -## Code Samples -### List thermostats - -To filter the list of returned thermostats, specify the desired parameters. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.list(); -``` - -#### Response - -```javascript -[ - { - "device_id": "123e4567-e89b-12d3-a456-426614174000", - "device_type": "ecobee_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z" - } - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.list() -``` - -#### Response - -```python -[ - Device( - device_id="123e4567-e89b-12d3-a456-426614174000", - device_type="ecobee_thermostat", - capabilities_supported=["thermostat"], - properties={ - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false, - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - }, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.list() -``` - -#### Response - -```ruby -[ - { - "device_id" => "123e4567-e89b-12d3-a456-426614174000", - "device_type" => "ecobee_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => { - name: "Entryway", - online: "true,", - relative_humidity: 0.36, - temperature_farenheit: 70, - available_hvac_mode_settings: %w[cool heat heat_cool off], - current_climate_setting: { - hvac_mode_setting: "heat_cool", - cooling_set_point_farenheit: 75, - heating_set_point_farenheit: 65, - manual_override_allowed: false, - }, - location: null, - connected_account_id: "123e4567-e89b-12d3-a456-426614174000", - workspace_id: "123e4567-e89b-12d3-a456-426614174000", - created_at: "2024-04-05T07:57:05.323Z", - }, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->list(); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "device_type" => "ecobee_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => [ - "name" => "Entryway", - "online" => "true,", - "relative_humidity" => 0.36, - "temperature_farenheit" => 70, - "available_hvac_mode_settings" => [ - "cool", - "heat", - "heat_cool", - "off", - ], - "current_climate_setting" => [ - "hvac_mode_setting" => "heat_cool", - "cooling_set_point_farenheit" => 75, - "heating_set_point_farenheit" => 65, - "manual_override_allowed" => false, - ], - "location" => null, - "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - ], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats list -``` - -#### Response - -```seam_cli -[ - { - "device_id": "123e4567-e89b-12d3-a456-426614174000", - "device_type": "ecobee_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z" - } - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.Thermostats.List(context.Background()) -} -``` - -#### Response - -```go -[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 25108600a..0242bd842 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -181,134 +181,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to off mode - -Specify the `device_id` of the thermostat that you want to set to off mode. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.off({ - device_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_THERMOSTAT_OFF" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_THERMOSTAT_OFF", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_THERMOSTAT_OFF", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_THERMOSTAT_OFF", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_THERMOSTAT_OFF" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Off( - context.Background(), - api.ThermostatsOffRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 40cdd6e4f..834ad88a1 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -255,186 +255,3 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) - -*** - -## Code Samples -### Create a thermostat schedule - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.create({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90, -}); -``` - -#### Response - -```javascript -{ - "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name": "Reservation 1", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-05T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.create( - device_id="123e4567-e89b-12d3-a456-426614174000", - name="Reservation 1", - climate_preset_key="occupied", - starts_at="2024-11-01T15:00:00Z", - ends_at="2024-11-05T12:00:00Z", - max_override_period_minutes=90, -) -``` - -#### Response - -```python -ThermostatSchedule( - thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a", - name="Reservation 1", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-01T15:00:00.000Z", - ends_at="2024-11-05T12:00:00.000Z", - max_override_period_minutes=90, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.create( - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90, -) -``` - -#### Response - -```ruby -{ - "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name" => "Reservation 1", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-05T12:00:00.000Z", - "max_override_period_minutes" => 90, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->create( - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90 -); -``` - -#### Response - -```php - "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name" => "Reservation 1", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-05T12:00:00.000Z", - "max_override_period_minutes" => 90, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 -``` - -#### Response - -```seam_cli -{ - "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name": "Reservation 1", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-05T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Create( - context.Background(), - schedules.SchedulesCreateRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - Name: api.String("Reservation 1"), - ClimatePresetKey: api.String("occupied"), - StartsAt: api.String("2024-11-01T15:00:00Z"), - EndsAt: api.String("2024-11-05T12:00:00Z"), - MaxOverridePeriodMinutes: api.Float64(90), - }, - ) -} -``` - -#### Response - -```go -api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 52fa56149..ca4fc4575 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -133,118 +133,3 @@ ID of the desired thermostat schedule. ## Return Type void - -*** - -## Code Samples -### Delete a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.delete({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.delete( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->delete( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Delete( - context.Background(), - schedules.SchedulesDeleteRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1cb2eff7c..1534426d7 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -174,159 +174,3 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) - -*** - -## Code Samples -### Get a specific thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.get({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", -}); -``` - -#### Response - -```javascript -{ - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.get( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" -) -``` - -#### Response - -```python -ThermostatSchedule( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - name="Reservation 2", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-10T15:00:00.000Z", - ends_at="2024-11-15T12:00:00.000Z", - max_override_period_minutes=90, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") -``` - -#### Response - -```ruby -{ - "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->get( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -); -``` - -#### Response - -```php - "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -``` - -#### Response - -```seam_cli -{ - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Get( - context.Background(), - schedules.SchedulesGetRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - }, - ) -} -``` - -#### Response - -```go -api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 8bc2bd352..3ee8d7463 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -236,212 +236,3 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array<[thermostat\_schedule](./)> - -*** - -## Code Samples -### List thermostat schedules for a thermostat - -Specify the `device_id` of the desired thermostat. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.list({ - device_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -[ - { - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 - }, - { - "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", - "name": "Reservation 3", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-16T15:00:00.000Z", - "ends_at": "2024-11-18T12:00:00.000Z", - "max_override_period_minutes": 90 - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -[ - ThermostatSchedule( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - name="Reservation 2", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-10T15:00:00.000Z", - ends_at="2024-11-15T12:00:00.000Z", - max_override_period_minutes=90, - ), - ThermostatSchedule( - thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959", - name="Reservation 3", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-16T15:00:00.000Z", - ends_at="2024-11-18T12:00:00.000Z", - max_override_period_minutes=90, - ), -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -[ - { - "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, - }, - { - "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", - "name" => "Reservation 3", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-16T15:00:00.000Z", - "ends_at" => "2024-11-18T12:00:00.000Z", - "max_override_period_minutes" => 90, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->list( - device_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, - ], - [ - "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", - "name" => "Reservation 3", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-16T15:00:00.000Z", - "ends_at" => "2024-11-18T12:00:00.000Z", - "max_override_period_minutes" => 90, - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -[ - { - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 - }, - { - "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", - "name": "Reservation 3", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-16T15:00:00.000Z", - "ends_at": "2024-11-18T12:00:00.000Z", - "max_override_period_minutes": 90 - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.List( - context.Background(), - schedules.SchedulesListRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 71697435e..3c72f533a 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -194,125 +194,3 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Return Type void - -*** - -## Code Samples -### Update a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.update({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.update( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at="2024-11-15T15:00:00Z", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.update( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->update( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Update( - context.Background(), - schedules.SchedulesUpdateRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - EndsAt: api.String("2024-11-15T15:00:00Z"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 780307793..2cbfe3e09 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -146,123 +146,3 @@ ID of the desired thermostat device. ## Return Type void - -*** - -## Code Samples -### Set the fallback climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setFallbackClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_fallback_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_fallback_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_fallback_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetFallbackClimatePreset( - context.Background(), - api.ThermostatsSetFallbackClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("eco"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index c5fc81c86..8f42e6633 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -209,144 +209,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set fan mode setting - -Specify the desired fan mode setting. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setFanMode({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto", -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_FAN_MODE" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_fan_mode( - device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto" -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_FAN_MODE", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_fan_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto", -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_FAN_MODE", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_fan_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_FAN_MODE", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_FAN_MODE" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetFanMode( - context.Background(), - api.ThermostatsSetFanModeRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FanModeSetting: api.String("auto"), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0e102e92e..05e2f4bb8 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -247,155 +247,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set HVAC mode - -Specify the desired heating and cooling set points in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setHvacMode({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "success", - "action_type": "SET_HVAC_MODE" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_hvac_mode( - device_id="123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting="heat_cool", - heating_set_point_celsius=20, - cooling_set_point_celsius=25, -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="success", - action_type="SET_HVAC_MODE", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_hvac_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "success", - "action_type" => "SET_HVAC_MODE", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_hvac_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "success", - "action_type" => "SET_HVAC_MODE", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "success", - "action_type": "SET_HVAC_MODE" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetHvacMode( - context.Background(), - api.ThermostatsSetHvacModeRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - HvacModeSetting: api.String("heat_cool"), - HeatingSetPointCelsius: api.Float64(20), - CoolingSetPointCelsius: api.Float64(25), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 0590a0ba1..ca66a4ecc 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -179,129 +179,3 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Return Type void - -*** - -## Code Samples -### Set a temperature threshold - -Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setTemperatureThreshold({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30, -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_temperature_threshold( - device_id="123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius=4, - upper_limit_celsius=30, -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_temperature_threshold( - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30, -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_temperature_threshold( - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30 -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetTemperatureThreshold( - context.Background(), - api.ThermostatsSetTemperatureThresholdRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - LowerLimitCelsius: api.Float64(4), - UpperLimitCelsius: api.Float64(30), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 5d17e66bc..490f7e8a4 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -71,8 +71,3 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 0176847da..467b35d50 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -44,8 +44,3 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index b00c2bf55..777f9bc9e 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -230,134 +230,3 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void - -*** - -## Code Samples -### Update a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.updateClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true, -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.update_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", - climate_preset_key="occupied", - cooling_set_point_celsius=24, - manual_override_allowed=true, -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.update_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true, -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->update_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.UpdateClimatePreset( - context.Background(), - api.ThermostatsUpdateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - CoolingSetPointCelsius: api.Float64(24), - ManualOverrideAllowed: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 299d79f08..af928ae44 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Add an ACS user to a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.addAcsUser({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.add_acs_user( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.add_acs_user( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->add_acs_user( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.AddAcsUser( - context.Background(), - api.UserIdentitiesAddAcsUserRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 8d95a69a3..817473e5c 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -221,180 +221,3 @@ Unique key for the user identity. ## Return Type [user\_identity](./) - -*** - -## Code Samples -### Create a user identity - -Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.create({ - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe", -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.create( - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - full_name="Jean Doe", -) -``` - -#### Response - -```python -UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.create( - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe", -) -``` - -#### Response - -```ruby -{ - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->create( - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe" -); -``` - -#### Response - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Create( - context.Background(), - api.UserIdentitiesCreateRequest{ - UserIdentityKey: api.String("jean_doe"), - EmailAddress: api.String("jean@example.com"), - PhoneNumber: api.String("+15555550110"), - FullName: api.String("Jean Doe"), - }, - ) -} -``` - -#### Response - -```go -api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 5cd1d2ae6..2bdc55ac5 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -129,115 +129,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Delete a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.delete({ - user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->delete( - user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Delete( - context.Background(), - api.UserIdentitiesDeleteRequest{ - UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 0fa34d659..2e1962b93 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -134,120 +134,3 @@ ID of the desired enrollment automation. ## Return Type void - -*** - -## Code Samples -### Delete an enrollment automation - -Specify the desired `enrollment_automation_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.delete({ - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.delete( - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.delete( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->delete( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Delete( - context.Background(), - enrollmentautomations.EnrollmentAutomationsDeleteRequest{ - EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index e1ca50c85..b53917f31 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -178,163 +178,3 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) - -*** - -## Code Samples -### Get an enrollment automation - -Specify the desired `enrollment_automation_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.get({ - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.get( - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" -) -``` - -#### Response - -```python -EnrollmentAutomation( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.get( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -) -``` - -#### Response - -```ruby -{ - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->get( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" -); -``` - -#### Response - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Get( - context.Background(), - enrollmentautomations.EnrollmentAutomationsGetRequest{ - EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), - }, - ) -} -``` - -#### Response - -```go -api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 694ceec93..5dc340903 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -228,178 +228,3 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) - -*** - -## Code Samples -### Launch an enrollment automation - -Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.launch({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true, -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.launch( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user=true, -) -``` - -#### Response - -```python -Unknown( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.launch( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true, -) -``` - -#### Response - -```ruby -{ - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->launch( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true -); -``` - -#### Response - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Launch( - context.Background(), - enrollmentautomations.EnrollmentAutomationsLaunchRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"), - AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"), - CreateCredentialManagerUser: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 24f3a00cc..8ed1a89c7 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -188,173 +188,3 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array<[enrollment\_automation](./)> - -*** - -## Code Samples -### List enrollment automations - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.list({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -}); -``` - -#### Response - -```javascript -[ - { - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.list( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" -) -``` - -#### Response - -```python -[ - EnrollmentAutomation( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.list( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -) -``` - -#### Response - -```ruby -[ - { - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->list( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -); -``` - -#### Response - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -``` - -#### Response - -```seam_cli -[ - { - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.List( - context.Background(), - enrollmentautomations.EnrollmentAutomationsListRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - }, - ) -} -``` - -#### Response - -```go -[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 6a167fe05..a76dbf454 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -184,161 +184,3 @@ Required: No ## Return Type [user\_identity](./) - -*** - -## Code Samples -### Get a user identity - -Specify the `user_identity_id` of the user identity that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.get({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Response - -```python -UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Response - -```ruby -{ - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->get( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -); -``` - -#### Response - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Get( - context.Background(), - api.UserIdentitiesGetRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - }, - ) -} -``` - -#### Response - -```go -api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index a9d9be01e..b5121cc74 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Grant a user identity access to a device - -Specify the desired `user_identity_id` and `device_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.grantAccessToDevice({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.grant_access_to_device( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id="054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.grant_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->grant_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.GrantAccessToDevice( - context.Background(), - api.UserIdentitiesGrantAccessToDeviceRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index f6c16069d..7044c7aaa 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -175,160 +175,3 @@ Required: No ## Return Type Array<[user\_identity](./)> - -*** - -## Code Samples -### List user identities - -To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.list(); -``` - -#### Response - -```javascript -[ - { - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list() -``` - -#### Response - -```python -[ - UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list() -``` - -#### Response - -```ruby -[ - { - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list(); -``` - -#### Response - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list -``` - -#### Response - -```seam_cli -[ - { - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.UserIdentities.List(context.Background()) -} -``` - -#### Response - -```go -[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 25ab353ef..e84acbefb 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -405,391 +405,3 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array<[device](./)> - -*** - -## Code Samples -### List accessible devices for a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.listAccessibleDevices({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", -}); -``` - -#### Response - -```javascript -[ - { - "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname": "", - "display_name": "Seam Thermostat", - "device_type": "nest_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68 - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": { "name": "" }, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false - }, - "location": null, - "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-02-29T21:57:33.397Z", - "errors": [], - "warnings": [], - "is_managed": true, - "custom_metadata": {} - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list_accessible_devices( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf" -) -``` - -#### Response - -```python -[ - Device( - device_id="054765c8-a2fc-4599-b486-14c19f462c45", - nickname="", - display_name="Seam Thermostat", - device_type="nest_thermostat", - capabilities_supported=["thermostat"], - properties={ - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a", - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68, - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": {"name": ""}, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false, - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false, - }, - location=None, - connected_account_id="44284499-a50b-4947-86c1-58264f014be5", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-02-29T21:57:33.397Z", - errors=[], - warnings=[], - is_managed=true, - custom_metadata={}, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list_accessible_devices( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", -) -``` - -#### Response - -```ruby -[ - { - "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname" => "", - "display_name" => "Seam Thermostat", - "device_type" => "nest_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => { - online: true, - is_cooling: false, - is_heating: false, - manufacturer: "nest", - nest_metadata: { - custom_name: "", - device_name: - "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a", - }, - is_fan_running: false, - has_direct_power: true, - relative_humidity: 0.46, - temperature_celsius: 24.64, - temperature_fahrenheit: 76.352, - current_climate_setting: { - hvac_mode_setting: "heat_cool", - manual_override_allowed: true, - cooling_set_point_celsius: 21.5, - heating_set_point_celsius: 20, - cooling_set_point_fahrenheit: 70.7, - heating_set_point_fahrenheit: 68, - }, - available_hvac_mode_settings: %w[heat cool heat_cool off], - is_temporary_manual_override_active: false, - name: "", - appearance: { - name: "", - }, - model: { - display_name: "Thermostat", - manufacturer_display_name: "Nest", - accessory_keypad_supported: false, - }, - image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - image_alt_text: "Placeholder Lock Image", - is_climate_setting_schedule_active: false, - }, - "location" => nil, - "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-02-29T21:57:33.397Z", - "errors" => [], - "warnings" => [], - "is_managed" => true, - "custom_metadata" => { - }, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list_accessible_devices( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf" -); -``` - -#### Response - -```php - "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname" => "", - "display_name" => "Seam Thermostat", - "device_type" => "nest_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => [ - "online" => true, - "is_cooling" => false, - "is_heating" => false, - "manufacturer" => "nest", - "nest_metadata" => [ - "custom_name" => "", - "device_name" => - "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a", - ], - "is_fan_running" => false, - "has_direct_power" => true, - "relative_humidity" => 0.46, - "temperature_celsius" => 24.64, - "temperature_fahrenheit" => 76.352, - "current_climate_setting" => [ - "hvac_mode_setting" => "heat_cool", - "manual_override_allowed" => true, - "cooling_set_point_celsius" => 21.5, - "heating_set_point_celsius" => 20, - "cooling_set_point_fahrenheit" => 70.7, - "heating_set_point_fahrenheit" => 68, - ], - "available_hvac_mode_settings" => [ - "heat", - "cool", - "heat_cool", - "off", - ], - "is_temporary_manual_override_active" => false, - "name" => "", - "appearance" => ["name" => ""], - "model" => [ - "display_name" => "Thermostat", - "manufacturer_display_name" => "Nest", - "accessory_keypad_supported" => false, - ], - "image_url" => - "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text" => "Placeholder Lock Image", - "is_climate_setting_schedule_active" => false, - ], - "location" => null, - "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-02-29T21:57:33.397Z", - "errors" => [], - "warnings" => [], - "is_managed" => true, - "custom_metadata" => [], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" -``` - -#### Response - -```seam_cli -[ - { - "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname": "", - "display_name": "Seam Thermostat", - "device_type": "nest_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68 - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": { "name": "" }, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false - }, - "location": null, - "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-02-29T21:57:33.397Z", - "errors": [], - "warnings": [], - "is_managed": true, - "custom_metadata": {} - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAccessibleDevices( - context.Background(), - api.UserIdentitiesListAccessibleDevicesRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - }, - ) -} -``` - -#### Response - -```go -[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index ab7e02076..27b7403e1 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -193,178 +193,3 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array<[acs\_system](./)> - -*** - -## Code Samples -### List ACS systems associated with a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.listAcsSystems({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -}); -``` - -#### Response - -```javascript -[ - { - "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "name": "Assa Abloy Credential Service", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-05T07:16:51.971Z", - "system_type": "assa_abloy_credential_service", - "system_type_display_name": "Assa Abloy Credential Service", - "external_type": "assa_abloy_credential_service", - "external_type_display_name": "Assa Abloy Credential Service", - "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list_acs_systems( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" -) -``` - -#### Response - -```python -[ - AcsSystem( - acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - name="Assa Abloy Credential Service", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-05T07:16:51.971Z", - system_type="assa_abloy_credential_service", - system_type_display_name="Assa Abloy Credential Service", - external_type="assa_abloy_credential_service", - external_type_display_name="Assa Abloy Credential Service", - connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") -``` - -#### Response - -```ruby -[ - { - "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "name" => "Assa Abloy Credential Service", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-05T07:16:51.971Z", - "system_type" => "assa_abloy_credential_service", - "system_type_display_name" => "Assa Abloy Credential Service", - "external_type" => "assa_abloy_credential_service", - "external_type_display_name" => "Assa Abloy Credential Service", - "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list_acs_systems( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -); -``` - -#### Response - -```php - "6737e186-8d54-48ce-a7da-a0be4d252172", - "name" => "Assa Abloy Credential Service", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-05T07:16:51.971Z", - "system_type" => "assa_abloy_credential_service", - "system_type_display_name" => "Assa Abloy Credential Service", - "external_type" => "assa_abloy_credential_service", - "external_type_display_name" => "Assa Abloy Credential Service", - "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -``` - -#### Response - -```seam_cli -[ - { - "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "name": "Assa Abloy Credential Service", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-05T07:16:51.971Z", - "system_type": "assa_abloy_credential_service", - "system_type_display_name": "Assa Abloy Credential Service", - "external_type": "assa_abloy_credential_service", - "external_type_display_name": "Assa Abloy Credential Service", - "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAcsSystems( - context.Background(), - api.UserIdentitiesListAcsSystemsRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index aedc13092..d585f3090 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -202,188 +202,3 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array<[acs\_user](./)> - -*** - -## Code Samples -### List ACS users for a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.listAcsUsers({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", -}); -``` - -#### Response - -```javascript -[ - { - "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "email_address": "jean@example.com", - "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-11T05:45:41.349Z", - "is_suspended": false, - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address": "jean@example.com", - "user_identity_phone_number": "+15555550110" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list_acs_users( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -) -``` - -#### Response - -```python -[ - AcsUser( - acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", - display_name="Jean Doe", - full_name="Jean Doe", - email_address="jean@example.com", - acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-11T05:45:41.349Z", - is_suspended=false, - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_email_address="jean@example.com", - user_identity_phone_number="+15555550110", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Response - -```ruby -[ - { - "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "email_address" => "jean@example.com", - "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-11T05:45:41.349Z", - "is_suspended" => false, - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address" => "jean@example.com", - "user_identity_phone_number" => "+15555550110", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list_acs_users( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -); -``` - -#### Response - -```php - "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "email_address" => "jean@example.com", - "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-11T05:45:41.349Z", - "is_suspended" => false, - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address" => "jean@example.com", - "user_identity_phone_number" => "+15555550110", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -``` - -#### Response - -```seam_cli -[ - { - "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "email_address": "jean@example.com", - "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-11T05:45:41.349Z", - "is_suspended": false, - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address": "jean@example.com", - "user_identity_phone_number": "+15555550110" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAcsUsers( - context.Background(), - api.UserIdentitiesListAcsUsersRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e395588e7..9ddac01d2 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Remove an ACS user from a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.removeAcsUser({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.remove_acs_user( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.remove_acs_user( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->remove_acs_user( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.RemoveAcsUser( - context.Background(), - api.UserIdentitiesRemoveAcsUserRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 0ef025d83..bf09b47be 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Revoke access to a device from a user identity - -Specify the desired `user_identity_id` and `device_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.revokeAccessToDevice({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.revoke_access_to_device( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id="054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.revoke_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->revoke_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.RevokeAccessToDevice( - context.Background(), - api.UserIdentitiesRevokeAccessToDeviceRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 619573a92..d5deb5c99 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -62,8 +62,3 @@ Unique key for the user identity. ## Return Type void - -*** - -## Code Samples - From 056f4b725b1647c48bc8490e79f0195a6873946d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:56:32 -0400 Subject: [PATCH 28/60] Update code-sample.hbs --- src/layouts/partials/code-sample.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/code-sample.hbs b/src/layouts/partials/code-sample.hbs index 73ef267e6..5302b5f86 100644 --- a/src/layouts/partials/code-sample.hbs +++ b/src/layouts/partials/code-sample.hbs @@ -1,13 +1,13 @@ {% tabs %} {{#each this.code}} {% tab title="{{this.title}}" %} -#### Request +#### Code ```{{@key}} {{this.request}} ``` -#### Response +#### Output ```{{@key}} {{this.response}} From db4a4c353e6782c1b78912f7c3a9388615c2740e Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 19:57:40 +0000 Subject: [PATCH 29/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 24 +++---- docs/api/acs/access_groups/get.md | 24 +++---- docs/api/acs/access_groups/list.md | 24 +++---- .../list_accessible_entrances.md | 24 +++---- docs/api/acs/access_groups/list_users.md | 24 +++---- docs/api/acs/access_groups/remove_user.md | 24 +++---- docs/api/acs/credentials/assign.md | 24 +++---- docs/api/acs/credentials/create.md | 24 +++---- docs/api/acs/credentials/delete.md | 24 +++---- docs/api/acs/credentials/get.md | 24 +++---- docs/api/acs/credentials/list.md | 24 +++---- .../credentials/list_accessible_entrances.md | 24 +++---- docs/api/acs/credentials/unassign.md | 24 +++---- docs/api/acs/credentials/update.md | 24 +++---- docs/api/acs/entrances/get.md | 24 +++---- docs/api/acs/entrances/list.md | 24 +++---- .../entrances/list_credentials_with_access.md | 24 +++---- docs/api/acs/systems/get.md | 24 +++---- docs/api/acs/systems/list.md | 24 +++---- ...mpatible_credential_manager_acs_systems.md | 24 +++---- docs/api/acs/users/add_to_access_group.md | 24 +++---- docs/api/acs/users/create.md | 72 +++++++++---------- docs/api/acs/users/delete.md | 24 +++---- docs/api/acs/users/get.md | 24 +++---- docs/api/acs/users/list.md | 24 +++---- .../api/acs/users/remove_from_access_group.md | 24 +++---- docs/api/acs/users/suspend.md | 24 +++---- docs/api/acs/users/unsuspend.md | 24 +++---- docs/api/acs/users/update.md | 24 +++---- .../thermostats/activate_climate_preset.md | 24 +++---- docs/api/thermostats/cool.md | 24 +++---- docs/api/thermostats/create_climate_preset.md | 24 +++---- docs/api/thermostats/delete_climate_preset.md | 24 +++---- docs/api/thermostats/heat.md | 24 +++---- docs/api/thermostats/heat_cool.md | 24 +++---- docs/api/thermostats/list.md | 24 +++---- docs/api/thermostats/off.md | 24 +++---- docs/api/thermostats/schedules/create.md | 24 +++---- docs/api/thermostats/schedules/delete.md | 24 +++---- docs/api/thermostats/schedules/get.md | 24 +++---- docs/api/thermostats/schedules/list.md | 24 +++---- docs/api/thermostats/schedules/update.md | 24 +++---- .../set_fallback_climate_preset.md | 24 +++---- docs/api/thermostats/set_fan_mode.md | 24 +++---- docs/api/thermostats/set_hvac_mode.md | 24 +++---- .../thermostats/set_temperature_threshold.md | 24 +++---- docs/api/thermostats/update_climate_preset.md | 24 +++---- docs/api/user_identities/add_acs_user.md | 24 +++---- docs/api/user_identities/create.md | 24 +++---- docs/api/user_identities/delete.md | 24 +++---- .../enrollment_automations/delete.md | 24 +++---- .../enrollment_automations/get.md | 24 +++---- .../enrollment_automations/launch.md | 24 +++---- .../enrollment_automations/list.md | 24 +++---- docs/api/user_identities/get.md | 24 +++---- .../user_identities/grant_access_to_device.md | 24 +++---- docs/api/user_identities/list.md | 24 +++---- .../list_accessible_devices.md | 24 +++---- docs/api/user_identities/list_acs_systems.md | 24 +++---- docs/api/user_identities/list_acs_users.md | 24 +++---- docs/api/user_identities/remove_acs_user.md | 24 +++---- .../revoke_access_to_device.md | 24 +++---- 62 files changed, 768 insertions(+), 768 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 983d05410..cb3a6ea88 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -8,7 +8,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.addUser({ @@ -17,7 +17,7 @@ await seam.acs.accessGroups.addUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.accessGroups.addUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.add_user( @@ -34,7 +34,7 @@ seam.acs.access_groups.add_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.add_user( @@ -51,7 +51,7 @@ seam.acs.access_groups.add_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->add_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e33a8cb19..2d145f3fe 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -8,7 +8,7 @@ Returns a specified [access group](https://docs.seam.co/latest/capability-guides {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.get({ @@ -16,7 +16,7 @@ await seam.acs.accessGroups.get({ }); ``` -#### Response +#### Output ```javascript { @@ -35,13 +35,13 @@ await seam.acs.accessGroups.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") ``` -#### Response +#### Output ```python AcsAccessGroup( @@ -60,13 +60,13 @@ AcsAccessGroup( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") ``` -#### Response +#### Output ```ruby { @@ -85,7 +85,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->get( ); ``` -#### Response +#### Output ```php acs->access_groups->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" ``` -#### Response +#### Output ```seam_cli { @@ -139,7 +139,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -157,7 +157,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 103b790ba..ac95b40bc 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -8,7 +8,7 @@ Returns a list of all [access groups](https://docs.seam.co/latest/capability-gui {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.list({ @@ -17,7 +17,7 @@ await seam.acs.accessGroups.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -38,7 +38,7 @@ await seam.acs.accessGroups.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.list( @@ -47,7 +47,7 @@ seam.acs.access_groups.list( ) ``` -#### Response +#### Output ```python [ @@ -68,7 +68,7 @@ seam.acs.access_groups.list( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.list( @@ -77,7 +77,7 @@ seam.acs.access_groups.list( ) ``` -#### Response +#### Output ```ruby [ @@ -98,7 +98,7 @@ seam.acs.access_groups.list( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->list( ); ``` -#### Response +#### Output ```php acs->access_groups->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" ``` -#### Response +#### Output ```seam_cli [ @@ -157,7 +157,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -176,7 +176,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 265ab76d3..22b221a49 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -8,7 +8,7 @@ Returns a list of all accessible entrances for a specified [access group](https: {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.listAccessibleEntrances({ @@ -16,7 +16,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ }); ``` -#### Response +#### Output ```javascript [ @@ -33,7 +33,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.list_accessible_entrances( @@ -41,7 +41,7 @@ seam.acs.access_groups.list_accessible_entrances( ) ``` -#### Response +#### Output ```python [ @@ -58,7 +58,7 @@ seam.acs.access_groups.list_accessible_entrances( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.list_accessible_entrances( @@ -66,7 +66,7 @@ seam.acs.access_groups.list_accessible_entrances( ) ``` -#### Response +#### Output ```ruby [ @@ -83,7 +83,7 @@ seam.acs.access_groups.list_accessible_entrances( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->list_accessible_entrances( ); ``` -#### Response +#### Output ```php acs->access_groups->list_accessible_entrances( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" ``` -#### Response +#### Output ```seam_cli [ @@ -133,7 +133,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -151,7 +151,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index c366a94a6..e783e3e1c 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -8,7 +8,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.listUsers({ @@ -16,7 +16,7 @@ await seam.acs.accessGroups.listUsers({ }); ``` -#### Response +#### Output ```javascript [ @@ -45,7 +45,7 @@ await seam.acs.accessGroups.listUsers({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.list_users( @@ -53,7 +53,7 @@ seam.acs.access_groups.list_users( ) ``` -#### Response +#### Output ```python [ @@ -82,13 +82,13 @@ seam.acs.access_groups.list_users( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") ``` -#### Response +#### Output ```ruby [ @@ -117,7 +117,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->list_users( ); ``` -#### Response +#### Output ```php acs->access_groups->list_users( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" ``` -#### Response +#### Output ```seam_cli [ @@ -191,7 +191,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -209,7 +209,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6902f8394..4f3cbd632 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -8,7 +8,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.removeUser({ @@ -17,7 +17,7 @@ await seam.acs.accessGroups.removeUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.accessGroups.removeUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.remove_user( @@ -34,7 +34,7 @@ seam.acs.access_groups.remove_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.remove_user( @@ -51,7 +51,7 @@ seam.acs.access_groups.remove_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->remove_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index e1cae31f5..4c8d29656 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -8,7 +8,7 @@ Assigns a specified [credential](../../../capability-guides/access-systems/manag {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.assign({ @@ -17,7 +17,7 @@ await seam.acs.credentials.assign({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.credentials.assign({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.assign( @@ -34,7 +34,7 @@ seam.acs.credentials.assign( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.assign( @@ -51,7 +51,7 @@ seam.acs.credentials.assign( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->assign( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index af1e25bfe..5af2ab77c 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -8,7 +8,7 @@ Creates a new [credential](../../../capability-guides/access-systems/managing-cr {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.create({ @@ -25,7 +25,7 @@ await seam.acs.credentials.create({ }); ``` -#### Response +#### Output ```javascript { @@ -43,7 +43,7 @@ await seam.acs.credentials.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.create( @@ -60,7 +60,7 @@ seam.acs.credentials.create( ) ``` -#### Response +#### Output ```python AcsCredential( @@ -78,7 +78,7 @@ AcsCredential( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.create( @@ -95,7 +95,7 @@ seam.acs.credentials.create( ) ``` -#### Response +#### Output ```ruby { @@ -113,7 +113,7 @@ seam.acs.credentials.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->create( ); ``` -#### Response +#### Output ```php acs->credentials->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" ``` -#### Response +#### Output ```seam_cli { @@ -174,7 +174,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -198,7 +198,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 9a0fee13f..4b88ad5e6 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -8,7 +8,7 @@ Deletes a specified [credential](../../../capability-guides/access-systems/manag {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.delete({ @@ -16,7 +16,7 @@ await seam.acs.credentials.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.credentials.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```ruby nil @@ -52,7 +52,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->delete( ); ``` -#### Response +#### Output ```php null @@ -69,13 +69,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli {} @@ -83,7 +83,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -101,7 +101,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 649794cee..7ebf1d496 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -8,7 +8,7 @@ Returns a specified [credential](../../../capability-guides/access-systems/manag {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.get({ @@ -16,7 +16,7 @@ await seam.acs.credentials.get({ }); ``` -#### Response +#### Output ```javascript { @@ -34,13 +34,13 @@ await seam.acs.credentials.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```python AcsCredential( @@ -58,13 +58,13 @@ AcsCredential( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```ruby { @@ -82,7 +82,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->get( ); ``` -#### Response +#### Output ```php acs->credentials->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli { @@ -134,7 +134,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -152,7 +152,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 2f656b113..989d3912e 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -8,7 +8,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.list({ @@ -19,7 +19,7 @@ await seam.acs.credentials.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -39,7 +39,7 @@ await seam.acs.credentials.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.list( @@ -50,7 +50,7 @@ seam.acs.credentials.list( ) ``` -#### Response +#### Output ```python [ @@ -70,7 +70,7 @@ seam.acs.credentials.list( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.list( @@ -81,7 +81,7 @@ seam.acs.credentials.list( ) ``` -#### Response +#### Output ```ruby [ @@ -101,7 +101,7 @@ seam.acs.credentials.list( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->list( ); ``` -#### Response +#### Output ```php acs->credentials->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true ``` -#### Response +#### Output ```seam_cli [ @@ -160,7 +160,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" - {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -181,7 +181,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3dddcd871..3356f1227 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -8,7 +8,7 @@ Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.listAccessibleEntrances({ @@ -16,7 +16,7 @@ await seam.acs.credentials.listAccessibleEntrances({ }); ``` -#### Response +#### Output ```javascript [ @@ -43,7 +43,7 @@ await seam.acs.credentials.listAccessibleEntrances({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.list_accessible_entrances( @@ -51,7 +51,7 @@ seam.acs.credentials.list_accessible_entrances( ) ``` -#### Response +#### Output ```python [ @@ -78,7 +78,7 @@ seam.acs.credentials.list_accessible_entrances( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.list_accessible_entrances( @@ -86,7 +86,7 @@ seam.acs.credentials.list_accessible_entrances( ) ``` -#### Response +#### Output ```ruby [ @@ -108,7 +108,7 @@ seam.acs.credentials.list_accessible_entrances( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->list_accessible_entrances( ); ``` -#### Response +#### Output ```php acs->credentials->list_accessible_entrances( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli [ @@ -178,7 +178,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -196,7 +196,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 187a30eb3..4be027357 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -8,7 +8,7 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/man {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.unassign({ @@ -17,7 +17,7 @@ await seam.acs.credentials.unassign({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.credentials.unassign({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.unassign( @@ -34,7 +34,7 @@ seam.acs.credentials.unassign( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.unassign( @@ -51,7 +51,7 @@ seam.acs.credentials.unassign( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->unassign( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 549c4a2b5..75b3370d3 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -8,7 +8,7 @@ Updates the code and ends at date and time for a specified [credential](../../.. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.update({ @@ -17,7 +17,7 @@ await seam.acs.credentials.update({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.credentials.update({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.update( @@ -33,7 +33,7 @@ seam.acs.credentials.update( ) ``` -#### Response +#### Output ```python None @@ -41,13 +41,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") ``` -#### Response +#### Output ```ruby nil @@ -55,7 +55,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->update( ); ``` -#### Response +#### Output ```php null @@ -73,13 +73,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" ``` -#### Response +#### Output ```seam_cli {} @@ -87,7 +87,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -106,7 +106,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index b4bbbbdf4..8780c5597 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -8,7 +8,7 @@ Returns a specified [ACS entrance](../../../capability-guides/access-systems/ret {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.entrances.get({ @@ -16,7 +16,7 @@ await seam.acs.entrances.get({ }); ``` -#### Response +#### Output ```javascript { @@ -29,13 +29,13 @@ await seam.acs.entrances.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python AcsEntrance( @@ -48,13 +48,13 @@ AcsEntrance( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby { @@ -67,7 +67,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->entrances->get( ); ``` -#### Response +#### Output ```php acs->entrances->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli { @@ -109,7 +109,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -127,7 +127,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index acf540d23..9e8696981 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -8,13 +8,13 @@ Returns a list of all [ACS entrances](../../../capability-guides/access-systems/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.entrances.list(); ``` -#### Response +#### Output ```javascript [ @@ -29,13 +29,13 @@ await seam.acs.entrances.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.entrances.list() ``` -#### Response +#### Output ```python [ @@ -50,13 +50,13 @@ seam.acs.entrances.list() {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.entrances.list() ``` -#### Response +#### Output ```ruby [ @@ -71,14 +71,14 @@ seam.acs.entrances.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->entrances->list(); ``` -#### Response +#### Output ```php acs->entrances->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs entrances list ``` -#### Response +#### Output ```seam_cli [ @@ -115,7 +115,7 @@ seam acs entrances list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -125,7 +125,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6cd85a7bf..f8d4dc4e1 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -8,7 +8,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.entrances.listCredentialsWithAccess({ @@ -16,7 +16,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ }); ``` -#### Response +#### Output ```javascript [ @@ -47,7 +47,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.entrances.list_credentials_with_access( @@ -55,7 +55,7 @@ seam.acs.entrances.list_credentials_with_access( ) ``` -#### Response +#### Output ```python [ @@ -86,7 +86,7 @@ seam.acs.entrances.list_credentials_with_access( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.entrances.list_credentials_with_access( @@ -94,7 +94,7 @@ seam.acs.entrances.list_credentials_with_access( ) ``` -#### Response +#### Output ```ruby [ @@ -125,7 +125,7 @@ seam.acs.entrances.list_credentials_with_access( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->entrances->list_credentials_with_access( ); ``` -#### Response +#### Output ```php acs->entrances->list_credentials_with_access( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli [ @@ -204,7 +204,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -222,7 +222,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index a4c54c150..c0eb0551f 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -10,7 +10,7 @@ Specify the desired access control system by including the corresponding `acs_sy {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.systems.get({ @@ -18,7 +18,7 @@ await seam.acs.systems.get({ }); ``` -#### Response +#### Output ```javascript [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -26,13 +26,13 @@ await seam.acs.systems.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python [AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] @@ -40,13 +40,13 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby [{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -54,14 +54,14 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -84,7 +84,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -102,7 +102,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 61766cfe3..05a22b0e9 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -12,7 +12,7 @@ response includes all access control systems connected to your workspace. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.systems.list({ @@ -20,7 +20,7 @@ await seam.acs.systems.list({ }); ``` -#### Response +#### Output ```javascript [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -28,13 +28,13 @@ await seam.acs.systems.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python [AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] @@ -42,13 +42,13 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000 {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby [{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -56,7 +56,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->systems->list( ); ``` -#### Response +#### Output ```php acs->systems->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -88,7 +88,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -106,7 +106,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 64204002a..9338af5c1 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -12,7 +12,7 @@ systems by including the corresponding `acs_system_id` in the request body. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ @@ -20,7 +20,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ }); ``` -#### Response +#### Output ```javascript [{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] @@ -28,7 +28,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.systems.list_compatible_credential_manager_acs_systems( @@ -36,7 +36,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ) ``` -#### Response +#### Output ```python [AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] @@ -44,7 +44,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.systems.list_compatible_credential_manager_acs_systems( @@ -52,7 +52,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ) ``` -#### Response +#### Output ```ruby [{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] @@ -60,7 +60,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->systems->list_compatible_credential_manager_acs_systems( ); ``` -#### Response +#### Output ```php acs->systems->list_compatible_credential_manager_acs_systems( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli [{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] @@ -92,7 +92,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 220fea9d0..c1da3c7fd 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -8,7 +8,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.addToAccessGroup({ @@ -17,7 +17,7 @@ await seam.acs.users.addToAccessGroup({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.users.addToAccessGroup({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.add_to_access_group( @@ -34,7 +34,7 @@ seam.acs.users.add_to_access_group( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.add_to_access_group( @@ -51,7 +51,7 @@ seam.acs.users.add_to_access_group( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->add_to_access_group( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 01ba1da82..f7028e637 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -8,7 +8,7 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-sy {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -19,7 +19,7 @@ await seam.acs.users.create({ }); ``` -#### Response +#### Output ```javascript { @@ -36,7 +36,7 @@ await seam.acs.users.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.create( @@ -47,7 +47,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```python AcsUser( @@ -64,7 +64,7 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.create( @@ -75,7 +75,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```ruby { @@ -92,7 +92,7 @@ seam.acs.users.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->create( ); ``` -#### Response +#### Output ```php acs->users->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" ``` -#### Response +#### Output ```seam_cli { @@ -145,7 +145,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -166,7 +166,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} @@ -263,7 +263,7 @@ ID of the user identity with which to associate the new `acs_user`. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -278,7 +278,7 @@ await seam.acs.users.create({ }); ``` -#### Response +#### Output ```javascript { @@ -295,7 +295,7 @@ await seam.acs.users.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.create( @@ -310,7 +310,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```python AcsUser( @@ -327,7 +327,7 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.create( @@ -342,7 +342,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```ruby { @@ -359,7 +359,7 @@ seam.acs.users.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->create( ); ``` -#### Response +#### Output ```php acs->users->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} ``` -#### Response +#### Output ```seam_cli { @@ -416,7 +416,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -438,7 +438,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} @@ -448,7 +448,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -460,7 +460,7 @@ await seam.acs.users.create({ }); ``` -#### Response +#### Output ```javascript { @@ -477,7 +477,7 @@ await seam.acs.users.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.create( @@ -489,7 +489,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```python AcsUser( @@ -506,7 +506,7 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.create( @@ -518,7 +518,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```ruby { @@ -535,7 +535,7 @@ seam.acs.users.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->create( ); ``` -#### Response +#### Output ```php acs->users->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] ``` -#### Response +#### Output ```seam_cli { @@ -589,7 +589,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -611,7 +611,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index fcae60e5b..a4a6e7537 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -8,7 +8,7 @@ Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.delete({ @@ -16,7 +16,7 @@ await seam.acs.users.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.users.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby nil @@ -52,14 +52,14 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php null @@ -67,13 +67,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli {} @@ -81,7 +81,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -99,7 +99,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 997149da3..08df27f88 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -8,7 +8,7 @@ Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.get({ @@ -16,7 +16,7 @@ await seam.acs.users.get({ }); ``` -#### Response +#### Output ```javascript { @@ -33,13 +33,13 @@ await seam.acs.users.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python AcsUser( @@ -56,13 +56,13 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby { @@ -79,14 +79,14 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli { @@ -127,7 +127,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -145,7 +145,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index b23c5a49e..630c4557b 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -8,13 +8,13 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.list(); ``` -#### Response +#### Output ```javascript { @@ -31,13 +31,13 @@ await seam.acs.users.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.list() ``` -#### Response +#### Output ```python AcsUser( @@ -54,13 +54,13 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.list() ``` -#### Response +#### Output ```ruby { @@ -77,14 +77,14 @@ seam.acs.users.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->list(); ``` -#### Response +#### Output ```php acs->users->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users list ``` -#### Response +#### Output ```seam_cli { @@ -125,7 +125,7 @@ seam acs users list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -135,7 +135,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7a5808809..7e1b25f13 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -8,7 +8,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.removeFromAccessGroup({ @@ -17,7 +17,7 @@ await seam.acs.users.removeFromAccessGroup({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.users.removeFromAccessGroup({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.remove_from_access_group( @@ -34,7 +34,7 @@ seam.acs.users.remove_from_access_group( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.remove_from_access_group( @@ -51,7 +51,7 @@ seam.acs.users.remove_from_access_group( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->remove_from_access_group( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 3e7988c69..bdb5eec73 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -8,7 +8,7 @@ POST /acs/users/suspend ⇒ void {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.suspend({ @@ -16,7 +16,7 @@ await seam.acs.users.suspend({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.users.suspend({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby nil @@ -52,14 +52,14 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php null @@ -67,13 +67,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli {} @@ -81,7 +81,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -99,7 +99,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index e2f624dd0..eed957e5c 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -8,7 +8,7 @@ POST /acs/users/unsuspend ⇒ void {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.unsuspend({ @@ -16,7 +16,7 @@ await seam.acs.users.unsuspend({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.users.unsuspend({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby nil @@ -52,7 +52,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->unsuspend( ); ``` -#### Response +#### Output ```php null @@ -69,13 +69,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli {} @@ -83,7 +83,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -101,7 +101,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index dccb7c8af..a9a5d70aa 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -8,7 +8,7 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/cap {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.update({ @@ -17,7 +17,7 @@ await seam.acs.users.update({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.users.update({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.update( @@ -33,7 +33,7 @@ seam.acs.users.update( ) ``` -#### Response +#### Output ```python None @@ -41,7 +41,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.update( @@ -50,7 +50,7 @@ seam.acs.users.update( ) ``` -#### Response +#### Output ```ruby nil @@ -58,7 +58,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->update( ); ``` -#### Response +#### Output ```php null @@ -76,13 +76,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" ``` -#### Response +#### Output ```seam_cli {} @@ -90,7 +90,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 2f654e1d3..0286eaca8 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -8,7 +8,7 @@ Activates a specified [climate preset](../../capability-guides/thermostats/creat {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.activateClimatePreset({ @@ -17,7 +17,7 @@ await seam.thermostats.activateClimatePreset({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.activateClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.activate_climate_preset( @@ -37,7 +37,7 @@ seam.thermostats.activate_climate_preset( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.activate_climate_preset( @@ -58,7 +58,7 @@ seam.thermostats.activate_climate_preset( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.activate_climate_preset( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->activate_climate_preset( ); ``` -#### Response +#### Output ```php thermostats->activate_climate_preset( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9794da83a..fd3f585c4 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.cool({ @@ -17,7 +17,7 @@ await seam.thermostats.cool({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.cool({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.cool( @@ -37,7 +37,7 @@ seam.thermostats.cool( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.cool( @@ -58,7 +58,7 @@ seam.thermostats.cool( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.cool( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->cool( ); ``` -#### Response +#### Output ```php thermostats->cool( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 069c4b3c5..68f7aea65 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -8,7 +8,7 @@ Creates a [climate preset](../../capability-guides/thermostats/creating-and-mana {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.createClimatePreset({ @@ -23,7 +23,7 @@ await seam.thermostats.createClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -31,7 +31,7 @@ await seam.thermostats.createClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.create_climate_preset( @@ -46,7 +46,7 @@ seam.thermostats.create_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -54,7 +54,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.create_climate_preset( @@ -69,7 +69,7 @@ seam.thermostats.create_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -77,7 +77,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->create_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -101,13 +101,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true ``` -#### Response +#### Output ```seam_cli {} @@ -115,7 +115,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -139,7 +139,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 570123781..1e11bfedd 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -8,7 +8,7 @@ Deletes a specified [climate preset](../../capability-guides/thermostats/creatin {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.deleteClimatePreset({ @@ -17,7 +17,7 @@ await seam.thermostats.deleteClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.thermostats.deleteClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.delete_climate_preset( @@ -33,7 +33,7 @@ seam.thermostats.delete_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -41,7 +41,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.delete_climate_preset( @@ -50,7 +50,7 @@ seam.thermostats.delete_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -58,7 +58,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->delete_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -76,13 +76,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" ``` -#### Response +#### Output ```seam_cli {} @@ -90,7 +90,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -108,7 +108,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index bb1189645..99d237be9 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.heat({ @@ -17,7 +17,7 @@ await seam.thermostats.heat({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.heat({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.heat( @@ -37,7 +37,7 @@ seam.thermostats.heat( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.heat( @@ -58,7 +58,7 @@ seam.thermostats.heat( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.heat( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->heat( ); ``` -#### Response +#### Output ```php thermostats->heat( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e29392489..7dd3535c7 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.heatCool({ @@ -18,7 +18,7 @@ await seam.thermostats.heatCool({ }); ``` -#### Response +#### Output ```javascript { @@ -30,7 +30,7 @@ await seam.thermostats.heatCool({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.heat_cool( @@ -40,7 +40,7 @@ seam.thermostats.heat_cool( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -52,7 +52,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.heat_cool( @@ -62,7 +62,7 @@ seam.thermostats.heat_cool( ) ``` -#### Response +#### Output ```ruby { @@ -74,7 +74,7 @@ seam.thermostats.heat_cool( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->heat_cool( ); ``` -#### Response +#### Output ```php thermostats->heat_cool( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 ``` -#### Response +#### Output ```seam_cli { @@ -116,7 +116,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" -- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -135,7 +135,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f0adedbe6..97e1d86ee 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -8,13 +8,13 @@ Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guide {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.list(); ``` -#### Response +#### Output ```javascript [ @@ -45,13 +45,13 @@ await seam.thermostats.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.list() ``` -#### Response +#### Output ```python [ @@ -82,13 +82,13 @@ seam.thermostats.list() {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.list() ``` -#### Response +#### Output ```ruby [ @@ -119,14 +119,14 @@ seam.thermostats.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->list(); ``` -#### Response +#### Output ```php thermostats->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats list ``` -#### Response +#### Output ```seam_cli [ @@ -200,7 +200,7 @@ seam thermostats list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -210,7 +210,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 0242bd842..cdcf5f277 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.off({ @@ -16,7 +16,7 @@ await seam.thermostats.off({ }); ``` -#### Response +#### Output ```javascript { @@ -28,13 +28,13 @@ await seam.thermostats.off({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python ActionAttempt( @@ -46,13 +46,13 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby { @@ -64,14 +64,14 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); ``` -#### Response +#### Output ```php thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli { @@ -102,7 +102,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -119,7 +119,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 834ad88a1..b3a65ad48 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -8,7 +8,7 @@ Creates a [thermostat schedule](../../../capability-guides/thermostats/creating- {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.create({ @@ -21,7 +21,7 @@ await seam.thermostats.schedules.create({ }); ``` -#### Response +#### Output ```javascript { @@ -37,7 +37,7 @@ await seam.thermostats.schedules.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.create( @@ -50,7 +50,7 @@ seam.thermostats.schedules.create( ) ``` -#### Response +#### Output ```python ThermostatSchedule( @@ -66,7 +66,7 @@ ThermostatSchedule( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.create( @@ -79,7 +79,7 @@ seam.thermostats.schedules.create( ) ``` -#### Response +#### Output ```ruby { @@ -95,7 +95,7 @@ seam.thermostats.schedules.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->create( ); ``` -#### Response +#### Output ```php thermostats->schedules->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 ``` -#### Response +#### Output ```seam_cli { @@ -148,7 +148,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -171,7 +171,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index ca4fc4575..caba8dcec 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -8,7 +8,7 @@ Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating- {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.delete({ @@ -16,7 +16,7 @@ await seam.thermostats.schedules.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,7 +24,7 @@ await seam.thermostats.schedules.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.delete( @@ -32,7 +32,7 @@ seam.thermostats.schedules.delete( ) ``` -#### Response +#### Output ```python None @@ -40,13 +40,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") ``` -#### Response +#### Output ```ruby nil @@ -54,7 +54,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->delete( ); ``` -#### Response +#### Output ```php null @@ -71,13 +71,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" ``` -#### Response +#### Output ```seam_cli {} @@ -85,7 +85,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -103,7 +103,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1534426d7..ea58299fc 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -8,7 +8,7 @@ Returns a specified [thermostat schedule](../../../capability-guides/thermostats {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.get({ @@ -16,7 +16,7 @@ await seam.thermostats.schedules.get({ }); ``` -#### Response +#### Output ```javascript { @@ -32,7 +32,7 @@ await seam.thermostats.schedules.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.get( @@ -40,7 +40,7 @@ seam.thermostats.schedules.get( ) ``` -#### Response +#### Output ```python ThermostatSchedule( @@ -56,13 +56,13 @@ ThermostatSchedule( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") ``` -#### Response +#### Output ```ruby { @@ -78,7 +78,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->get( ); ``` -#### Response +#### Output ```php thermostats->schedules->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" ``` -#### Response +#### Output ```seam_cli { @@ -126,7 +126,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -144,7 +144,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3ee8d7463..eb7144bfe 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -8,7 +8,7 @@ Returns a list of all [thermostat schedules](../../../capability-guides/thermost {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.list({ @@ -16,7 +16,7 @@ await seam.thermostats.schedules.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -43,13 +43,13 @@ await seam.thermostats.schedules.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python [ @@ -76,13 +76,13 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby [ @@ -109,7 +109,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->list( ); ``` -#### Response +#### Output ```php thermostats->schedules->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli [ @@ -179,7 +179,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -197,7 +197,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 3c72f533a..2e3ed380d 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -8,7 +8,7 @@ Updates a specified [thermostat schedule](../../../capability-guides/thermostats {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.update({ @@ -17,7 +17,7 @@ await seam.thermostats.schedules.update({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.thermostats.schedules.update({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.update( @@ -34,7 +34,7 @@ seam.thermostats.schedules.update( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.update( @@ -51,7 +51,7 @@ seam.thermostats.schedules.update( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->update( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2cbfe3e09..7d005b9e8 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -8,7 +8,7 @@ Sets a specified [climate preset](../../capability-guides/thermostats/creating-a {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setFallbackClimatePreset({ @@ -17,7 +17,7 @@ await seam.thermostats.setFallbackClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.thermostats.setFallbackClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_fallback_climate_preset( @@ -33,7 +33,7 @@ seam.thermostats.set_fallback_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -41,7 +41,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_fallback_climate_preset( @@ -50,7 +50,7 @@ seam.thermostats.set_fallback_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -58,7 +58,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_fallback_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -76,13 +76,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" ``` -#### Response +#### Output ```seam_cli {} @@ -90,7 +90,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -108,7 +108,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 8f42e6633..f168bf8d3 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -8,7 +8,7 @@ Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermo {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setFanMode({ @@ -17,7 +17,7 @@ await seam.thermostats.setFanMode({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.setFanMode({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_fan_mode( @@ -37,7 +37,7 @@ seam.thermostats.set_fan_mode( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_fan_mode( @@ -58,7 +58,7 @@ seam.thermostats.set_fan_mode( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.set_fan_mode( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_fan_mode( ); ``` -#### Response +#### Output ```php thermostats->set_fan_mode( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 05e2f4bb8..4284c60a7 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -8,7 +8,7 @@ Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/c {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setHvacMode({ @@ -19,7 +19,7 @@ await seam.thermostats.setHvacMode({ }); ``` -#### Response +#### Output ```javascript { @@ -31,7 +31,7 @@ await seam.thermostats.setHvacMode({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_hvac_mode( @@ -42,7 +42,7 @@ seam.thermostats.set_hvac_mode( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -54,7 +54,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_hvac_mode( @@ -65,7 +65,7 @@ seam.thermostats.set_hvac_mode( ) ``` -#### Response +#### Output ```ruby { @@ -77,7 +77,7 @@ seam.thermostats.set_hvac_mode( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_hvac_mode( ); ``` -#### Response +#### Output ```php thermostats->set_hvac_mode( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 ``` -#### Response +#### Output ```seam_cli { @@ -120,7 +120,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -140,7 +140,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index ca66a4ecc..739e33b13 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -8,7 +8,7 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setTemperatureThreshold({ @@ -18,7 +18,7 @@ await seam.thermostats.setTemperatureThreshold({ }); ``` -#### Response +#### Output ```javascript // void @@ -26,7 +26,7 @@ await seam.thermostats.setTemperatureThreshold({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_temperature_threshold( @@ -36,7 +36,7 @@ seam.thermostats.set_temperature_threshold( ) ``` -#### Response +#### Output ```python None @@ -44,7 +44,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_temperature_threshold( @@ -54,7 +54,7 @@ seam.thermostats.set_temperature_threshold( ) ``` -#### Response +#### Output ```ruby nil @@ -62,7 +62,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_temperature_threshold( ); ``` -#### Response +#### Output ```php null @@ -81,13 +81,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 ``` -#### Response +#### Output ```seam_cli {} @@ -95,7 +95,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -114,7 +114,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 777f9bc9e..3c19b84de 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -8,7 +8,7 @@ Updates a specified [climate preset](../../capability-guides/thermostats/creatin {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.updateClimatePreset({ @@ -19,7 +19,7 @@ await seam.thermostats.updateClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -27,7 +27,7 @@ await seam.thermostats.updateClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.update_climate_preset( @@ -38,7 +38,7 @@ seam.thermostats.update_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -46,7 +46,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.update_climate_preset( @@ -57,7 +57,7 @@ seam.thermostats.update_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -65,7 +65,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->update_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -85,13 +85,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true ``` -#### Response +#### Output ```seam_cli {} @@ -99,7 +99,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -119,7 +119,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index af928ae44..bd5301b5d 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -8,7 +8,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.addAcsUser({ @@ -17,7 +17,7 @@ await seam.userIdentities.addAcsUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.addAcsUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.add_acs_user( @@ -34,7 +34,7 @@ seam.user_identities.add_acs_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.add_acs_user( @@ -51,7 +51,7 @@ seam.user_identities.add_acs_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->add_acs_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 817473e5c..51ea9a19d 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -8,7 +8,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobi {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.create({ @@ -19,7 +19,7 @@ await seam.userIdentities.create({ }); ``` -#### Response +#### Output ```javascript { @@ -36,7 +36,7 @@ await seam.userIdentities.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.create( @@ -47,7 +47,7 @@ seam.user_identities.create( ) ``` -#### Response +#### Output ```python UserIdentity( @@ -64,7 +64,7 @@ UserIdentity( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.create( @@ -75,7 +75,7 @@ seam.user_identities.create( ) ``` -#### Response +#### Output ```ruby { @@ -92,7 +92,7 @@ seam.user_identities.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->create( ); ``` -#### Response +#### Output ```php user_identities->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" ``` -#### Response +#### Output ```seam_cli { @@ -145,7 +145,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -165,7 +165,7 @@ func main() { } ``` -#### Response +#### Output ```go api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 2bdc55ac5..87696af33 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -8,7 +8,7 @@ Deletes a specified [user identity](https://docs.seam.co/latest/capability-guide {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.delete({ @@ -16,7 +16,7 @@ await seam.userIdentities.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.userIdentities.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") ``` -#### Response +#### Output ```ruby nil @@ -52,7 +52,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->delete( ); ``` -#### Response +#### Output ```php null @@ -69,13 +69,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" ``` -#### Response +#### Output ```seam_cli {} @@ -83,7 +83,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -100,7 +100,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 2e1962b93..775789e14 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -8,7 +8,7 @@ Deletes a specified [enrollment automation](https://docs.seam.co/latest/capabili {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.delete({ @@ -16,7 +16,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,7 +24,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.delete( @@ -32,7 +32,7 @@ seam.user_identities.enrollment_automations.delete( ) ``` -#### Response +#### Output ```python None @@ -40,7 +40,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.delete( @@ -48,7 +48,7 @@ seam.user_identities.enrollment_automations.delete( ) ``` -#### Response +#### Output ```ruby nil @@ -56,7 +56,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->delete( ); ``` -#### Response +#### Output ```php null @@ -73,13 +73,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" ``` -#### Response +#### Output ```seam_cli {} @@ -87,7 +87,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -105,7 +105,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index b53917f31..6d5c1bd19 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -8,7 +8,7 @@ Returns a specified [enrollment automation](https://docs.seam.co/latest/capabili {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.get({ @@ -16,7 +16,7 @@ await seam.userIdentities.enrollmentAutomations.get({ }); ``` -#### Response +#### Output ```javascript { @@ -32,7 +32,7 @@ await seam.userIdentities.enrollmentAutomations.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.get( @@ -40,7 +40,7 @@ seam.user_identities.enrollment_automations.get( ) ``` -#### Response +#### Output ```python EnrollmentAutomation( @@ -56,7 +56,7 @@ EnrollmentAutomation( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.get( @@ -64,7 +64,7 @@ seam.user_identities.enrollment_automations.get( ) ``` -#### Response +#### Output ```ruby { @@ -80,7 +80,7 @@ seam.user_identities.enrollment_automations.get( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->get( ); ``` -#### Response +#### Output ```php user_identities->enrollment_automations->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" ``` -#### Response +#### Output ```seam_cli { @@ -130,7 +130,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -148,7 +148,7 @@ func main() { } ``` -#### Response +#### Output ```go api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 5dc340903..2f8592bb8 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -8,7 +8,7 @@ Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-gui {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.launch({ @@ -19,7 +19,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ }); ``` -#### Response +#### Output ```javascript { @@ -35,7 +35,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.launch( @@ -46,7 +46,7 @@ seam.user_identities.enrollment_automations.launch( ) ``` -#### Response +#### Output ```python Unknown( @@ -62,7 +62,7 @@ Unknown( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.launch( @@ -73,7 +73,7 @@ seam.user_identities.enrollment_automations.launch( ) ``` -#### Response +#### Output ```ruby { @@ -89,7 +89,7 @@ seam.user_identities.enrollment_automations.launch( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->launch( ); ``` -#### Response +#### Output ```php user_identities->enrollment_automations->launch( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true ``` -#### Response +#### Output ```seam_cli { @@ -142,7 +142,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -163,7 +163,7 @@ func main() { } ``` -#### Response +#### Output ```go api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 8ed1a89c7..a8714b3dc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -8,7 +8,7 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capab {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.list({ @@ -16,7 +16,7 @@ await seam.userIdentities.enrollmentAutomations.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -34,7 +34,7 @@ await seam.userIdentities.enrollmentAutomations.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.list( @@ -42,7 +42,7 @@ seam.user_identities.enrollment_automations.list( ) ``` -#### Response +#### Output ```python [ @@ -60,7 +60,7 @@ seam.user_identities.enrollment_automations.list( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.list( @@ -68,7 +68,7 @@ seam.user_identities.enrollment_automations.list( ) ``` -#### Response +#### Output ```ruby [ @@ -86,7 +86,7 @@ seam.user_identities.enrollment_automations.list( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->list( ); ``` -#### Response +#### Output ```php user_identities->enrollment_automations->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" ``` -#### Response +#### Output ```seam_cli [ @@ -140,7 +140,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -158,7 +158,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a76dbf454..886a1925c 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -8,7 +8,7 @@ Returns a specified [user identity](https://docs.seam.co/latest/capability-guide {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.get({ @@ -16,7 +16,7 @@ await seam.userIdentities.get({ }); ``` -#### Response +#### Output ```javascript { @@ -33,13 +33,13 @@ await seam.userIdentities.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") ``` -#### Response +#### Output ```python UserIdentity( @@ -56,13 +56,13 @@ UserIdentity( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") ``` -#### Response +#### Output ```ruby { @@ -79,7 +79,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->get( ); ``` -#### Response +#### Output ```php user_identities->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" ``` -#### Response +#### Output ```seam_cli { @@ -129,7 +129,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -146,7 +146,7 @@ func main() { } ``` -#### Response +#### Output ```go api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index b5121cc74..2e2471478 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -8,7 +8,7 @@ Grants a specified [user identity](https://docs.seam.co/latest/capability-guides {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.grantAccessToDevice({ @@ -17,7 +17,7 @@ await seam.userIdentities.grantAccessToDevice({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.grantAccessToDevice({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.grant_access_to_device( @@ -34,7 +34,7 @@ seam.user_identities.grant_access_to_device( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.grant_access_to_device( @@ -51,7 +51,7 @@ seam.user_identities.grant_access_to_device( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->grant_access_to_device( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7044c7aaa..1c778e2c0 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -8,13 +8,13 @@ Returns a list of all [user identities](https://docs.seam.co/latest/capability-g {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.list(); ``` -#### Response +#### Output ```javascript [ @@ -33,13 +33,13 @@ await seam.userIdentities.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list() ``` -#### Response +#### Output ```python [ @@ -58,13 +58,13 @@ seam.user_identities.list() {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list() ``` -#### Response +#### Output ```ruby [ @@ -83,14 +83,14 @@ seam.user_identities.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list(); ``` -#### Response +#### Output ```php user_identities->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list ``` -#### Response +#### Output ```seam_cli [ @@ -135,7 +135,7 @@ seam user-identities list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -145,7 +145,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index e84acbefb..a2a0cde8e 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -8,7 +8,7 @@ Returns a list of all [devices](../../core-concepts/devices/README.md) associate {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.listAccessibleDevices({ @@ -16,7 +16,7 @@ await seam.userIdentities.listAccessibleDevices({ }); ``` -#### Response +#### Output ```javascript [ @@ -76,7 +76,7 @@ await seam.userIdentities.listAccessibleDevices({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list_accessible_devices( @@ -84,7 +84,7 @@ seam.user_identities.list_accessible_devices( ) ``` -#### Response +#### Output ```python [ @@ -144,7 +144,7 @@ seam.user_identities.list_accessible_devices( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list_accessible_devices( @@ -152,7 +152,7 @@ seam.user_identities.list_accessible_devices( ) ``` -#### Response +#### Output ```ruby [ @@ -216,7 +216,7 @@ seam.user_identities.list_accessible_devices( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list_accessible_devices( ); ``` -#### Response +#### Output ```php user_identities->list_accessible_devices( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" ``` -#### Response +#### Output ```seam_cli [ @@ -359,7 +359,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -376,7 +376,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 27b7403e1..04df25910 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -8,7 +8,7 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capab {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.listAcsSystems({ @@ -16,7 +16,7 @@ await seam.userIdentities.listAcsSystems({ }); ``` -#### Response +#### Output ```javascript [ @@ -36,7 +36,7 @@ await seam.userIdentities.listAcsSystems({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list_acs_systems( @@ -44,7 +44,7 @@ seam.user_identities.list_acs_systems( ) ``` -#### Response +#### Output ```python [ @@ -64,13 +64,13 @@ seam.user_identities.list_acs_systems( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") ``` -#### Response +#### Output ```ruby [ @@ -90,7 +90,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list_acs_systems( ); ``` -#### Response +#### Output ```php user_identities->list_acs_systems( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" ``` -#### Response +#### Output ```seam_cli [ @@ -146,7 +146,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -163,7 +163,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index d585f3090..1c0d08db1 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -8,7 +8,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.listAcsUsers({ @@ -16,7 +16,7 @@ await seam.userIdentities.listAcsUsers({ }); ``` -#### Response +#### Output ```javascript [ @@ -38,7 +38,7 @@ await seam.userIdentities.listAcsUsers({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list_acs_users( @@ -46,7 +46,7 @@ seam.user_identities.list_acs_users( ) ``` -#### Response +#### Output ```python [ @@ -68,13 +68,13 @@ seam.user_identities.list_acs_users( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") ``` -#### Response +#### Output ```ruby [ @@ -96,7 +96,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list_acs_users( ); ``` -#### Response +#### Output ```php user_identities->list_acs_users( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" ``` -#### Response +#### Output ```seam_cli [ @@ -156,7 +156,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -173,7 +173,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 9ddac01d2..e5583c1a2 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -8,7 +8,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.removeAcsUser({ @@ -17,7 +17,7 @@ await seam.userIdentities.removeAcsUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.removeAcsUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.remove_acs_user( @@ -34,7 +34,7 @@ seam.user_identities.remove_acs_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.remove_acs_user( @@ -51,7 +51,7 @@ seam.user_identities.remove_acs_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->remove_acs_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index bf09b47be..8613ef686 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -8,7 +8,7 @@ Revokes access to a specified [device](../../core-concepts/devices/README.md) fr {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.revokeAccessToDevice({ @@ -17,7 +17,7 @@ await seam.userIdentities.revokeAccessToDevice({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.revokeAccessToDevice({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.revoke_access_to_device( @@ -34,7 +34,7 @@ seam.user_identities.revoke_access_to_device( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.revoke_access_to_device( @@ -51,7 +51,7 @@ seam.user_identities.revoke_access_to_device( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->revoke_access_to_device( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil From 5bd81dd5236f2c3be82e42d5b9783bf9fcc2251b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:59:14 -0400 Subject: [PATCH 30/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 1d65fc9ad..5feafed62 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -20,7 +20,9 @@ {{/if}} {{/each}} +--- {{/if}} + ## Request Parameters {{#if request.parameters.length}} @@ -32,13 +34,16 @@ Required: {{#if this.required}}Yes{{else}}No{{/if}} {{this.description}} -*** +--- {{/each}} {{else}} None {{/if}} + +--- + ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} @@ -48,9 +53,11 @@ None {{/with}} {{#if addtionalCodeSamples.length}} -## Additional Code Samples +--- + +## Code Samples {{#each addtionalCodeSamples}} {{> code-sample }} {{/each}} -{{/if}} \ No newline at end of file +{{/if}} From fd2abcec0eec4f8e52457820d16f247e496a8be0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:59:52 -0400 Subject: [PATCH 31/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 5feafed62..b0385100a 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -58,6 +58,10 @@ None ## Code Samples {{#each addtionalCodeSamples}} +### {{this.title}} + +{{this.description}} + {{> code-sample }} {{/each}} {{/if}} From d718e19e6b7654c5f8c4e3cbb3f68304d4a25e32 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 20:00:57 +0000 Subject: [PATCH 32/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 9 +++-- docs/api/acs/access_groups/get.md | 7 +++- docs/api/acs/access_groups/list.md | 9 +++-- .../list_accessible_entrances.md | 7 +++- docs/api/acs/access_groups/list_users.md | 7 +++- docs/api/acs/access_groups/remove_user.md | 9 +++-- docs/api/acs/credentials/assign.md | 9 +++-- docs/api/acs/credentials/create.md | 27 ++++++++------- docs/api/acs/credentials/delete.md | 7 +++- docs/api/acs/credentials/get.md | 7 +++- docs/api/acs/credentials/list.md | 17 ++++++---- .../credentials/list_accessible_entrances.md | 7 +++- docs/api/acs/credentials/unassign.md | 9 +++-- docs/api/acs/credentials/update.md | 11 +++++-- docs/api/acs/encoders/encode_credential.md | 9 +++-- docs/api/acs/encoders/list.md | 13 +++++--- docs/api/acs/encoders/scan_credential.md | 7 +++- .../next_credential_encode_will_fail.md | 11 +++++-- .../next_credential_encode_will_succeed.md | 9 +++-- .../next_credential_scan_will_fail.md | 11 +++++-- .../next_credential_scan_will_succeed.md | 11 +++++-- docs/api/acs/entrances/get.md | 7 +++- docs/api/acs/entrances/grant_access.md | 9 +++-- docs/api/acs/entrances/list.md | 9 +++-- .../entrances/list_credentials_with_access.md | 9 +++-- docs/api/acs/systems/get.md | 7 +++- docs/api/acs/systems/list.md | 7 +++- ...mpatible_credential_manager_acs_systems.md | 7 +++- docs/api/acs/users/add_to_access_group.md | 9 +++-- docs/api/acs/users/create.md | 33 ++++++++++++++----- docs/api/acs/users/delete.md | 7 +++- docs/api/acs/users/get.md | 7 +++- docs/api/acs/users/list.md | 21 +++++++----- .../acs/users/list_accessible_entrances.md | 7 +++- .../api/acs/users/remove_from_access_group.md | 9 +++-- .../users/revoke_access_to_all_entrances.md | 7 +++- docs/api/acs/users/suspend.md | 7 +++- docs/api/acs/users/unsuspend.md | 7 +++- docs/api/acs/users/update.md | 19 +++++++---- docs/api/phones/deactivate.md | 7 +++- docs/api/phones/get.md | 7 +++- docs/api/phones/list.md | 9 +++-- .../phones/simulate/create_sandbox_phone.md | 13 +++++--- .../thermostats/activate_climate_preset.md | 9 +++-- docs/api/thermostats/cool.md | 11 +++++-- docs/api/thermostats/create_climate_preset.md | 25 ++++++++------ docs/api/thermostats/delete_climate_preset.md | 9 +++-- docs/api/thermostats/heat.md | 11 +++++-- docs/api/thermostats/heat_cool.md | 15 ++++++--- docs/api/thermostats/list.md | 27 ++++++++------- docs/api/thermostats/off.md | 7 +++- docs/api/thermostats/schedules/create.md | 19 +++++++---- docs/api/thermostats/schedules/delete.md | 7 +++- docs/api/thermostats/schedules/get.md | 7 +++- docs/api/thermostats/schedules/list.md | 9 +++-- docs/api/thermostats/schedules/update.md | 19 +++++++---- .../set_fallback_climate_preset.md | 9 +++-- docs/api/thermostats/set_fan_mode.md | 11 +++++-- docs/api/thermostats/set_hvac_mode.md | 17 ++++++---- .../thermostats/set_temperature_threshold.md | 15 ++++++--- .../simulate/hvac_mode_adjusted.md | 17 ++++++---- .../simulate/temperature_reached.md | 11 +++++-- docs/api/thermostats/update_climate_preset.md | 25 ++++++++------ docs/api/user_identities/add_acs_user.md | 9 +++-- docs/api/user_identities/create.md | 13 +++++--- docs/api/user_identities/delete.md | 7 +++- .../enrollment_automations/delete.md | 7 +++- .../enrollment_automations/get.md | 7 +++- .../enrollment_automations/launch.md | 15 ++++++--- .../enrollment_automations/list.md | 7 +++- docs/api/user_identities/get.md | 9 +++-- .../user_identities/grant_access_to_device.md | 9 +++-- docs/api/user_identities/list.md | 7 +++- .../list_accessible_devices.md | 7 +++- docs/api/user_identities/list_acs_systems.md | 7 +++- docs/api/user_identities/list_acs_users.md | 7 +++- docs/api/user_identities/remove_acs_user.md | 9 +++-- .../revoke_access_to_device.md | 9 +++-- docs/api/user_identities/update.md | 15 ++++++--- 79 files changed, 633 insertions(+), 228 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index cb3a6ea88..64b7cf53b 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 2d145f3fe..61eafdcc4 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -172,6 +172,8 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -181,7 +183,10 @@ Required: Yes ID of the desired access group. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index ac95b40bc..8e5d846b6 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -191,6 +191,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -200,7 +202,7 @@ Required: No ID of the access control system for which you want to retrieve all access groups. -*** +--- ### `acs_user_id` @@ -209,7 +211,10 @@ Required: No ID of the user for which you want to retrieve all access groups. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 22b221a49..7c8e0ea1e 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -166,6 +166,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -175,7 +177,10 @@ Required: Yes ID of the access group for which you want to retrieve all accessible entrances. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index e783e3e1c..be8fbb3fb 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -224,6 +224,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -233,7 +235,10 @@ Required: Yes ID of the access group for which you want to retrieve all users. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 4f3cbd632..20a359563 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 4c8d29656..cff78cef3 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired credential. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 5af2ab77c..e8f14d461 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -213,6 +213,8 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `access_method` @@ -222,7 +224,7 @@ Required: Yes Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. -*** +--- ### `acs_user_id` @@ -231,7 +233,7 @@ Required: Yes ID of the ACS user to whom the new credential belongs. -*** +--- ### `allowed_acs_entrance_ids` @@ -240,7 +242,7 @@ Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. -*** +--- ### `assa_abloy_vostio_metadata` @@ -249,7 +251,7 @@ Required: No Vostio-specific metadata for the new credential. -*** +--- ### `code` @@ -258,7 +260,7 @@ Required: No Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). -*** +--- ### `credential_manager_acs_system_id` @@ -267,7 +269,7 @@ Required: No ACS system ID of the credential manager for the new credential. -*** +--- ### `ends_at` @@ -276,7 +278,7 @@ Required: No Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. -*** +--- ### `is_multi_phone_sync_credential` @@ -285,7 +287,7 @@ Required: No Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). -*** +--- ### `salto_space_metadata` @@ -294,7 +296,7 @@ Required: No Salto Space-specific metadata for the new credential. -*** +--- ### `starts_at` @@ -303,7 +305,7 @@ Required: No Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `visionline_metadata` @@ -312,7 +314,10 @@ Required: No Visionline-specific metadata for the new credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 4b88ad5e6..21871a698 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -116,6 +116,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -125,7 +127,10 @@ Required: Yes ID of the desired credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 7ebf1d496..cf4fcb86d 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -167,6 +167,8 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -176,7 +178,10 @@ Required: Yes ID of the desired credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 989d3912e..e2648b4c4 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -197,6 +197,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -206,7 +208,7 @@ Required: No ID of the access control system for which you want to retrieve all credentials. -*** +--- ### `acs_user_id` @@ -215,7 +217,7 @@ Required: No ID of the ACS user for which you want to retrieve all credentials. -*** +--- ### `created_before` @@ -224,7 +226,7 @@ Required: No Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. -*** +--- ### `is_multi_phone_sync_credential` @@ -233,7 +235,7 @@ Required: No Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. -*** +--- ### `limit` @@ -242,7 +244,7 @@ Required: No Number of credentials to return. -*** +--- ### `user_identity_id` @@ -251,7 +253,10 @@ Required: No ID of the user identity for which you want to retrieve all credentials. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3356f1227..040f8bc77 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -211,6 +211,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -220,7 +222,10 @@ Required: Yes ID of the credential for which you want to retrieve all entrances to which this credential grants access. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 4be027357..8f47b4362 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired credential. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 75b3370d3..32c3ba597 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -121,6 +121,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -130,7 +132,7 @@ Required: Yes ID of the desired credential. -*** +--- ### `code` @@ -139,7 +141,7 @@ Required: No Replacement access (PIN) code for the credential. -*** +--- ### `ends_at` @@ -148,7 +150,10 @@ Required: No Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 5a6a6b23a..27b5cda02 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -12,6 +12,8 @@ Encodes an existing [credential](../../../capability-guides/access-systems/manag - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_credential` to encode onto a card. -*** +--- ### `acs_encoder_id` @@ -30,7 +32,10 @@ Required: Yes ID of the `acs_encoder` to use to encode the `acs_credential`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5705eee18..cc1cdc891 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -12,6 +12,8 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_ids` @@ -21,7 +23,7 @@ Required: No IDs of the `acs_encoder`s that you want to retrieve. -*** +--- ### `acs_system_id` @@ -30,7 +32,7 @@ Required: No ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. -*** +--- ### `acs_system_ids` @@ -39,7 +41,7 @@ Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. -*** +--- ### `limit` @@ -48,7 +50,10 @@ Required: No Number of `acs_encoders` to return. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index b84d478c2..95f13b6b2 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -12,6 +12,8 @@ Scans an encoded [acs_credential](../../../capability-guides/access-systems/mana - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,10 @@ Required: Yes ID of the `acs_encoder` to use for the scan. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 5f919c365..74ab12327 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -12,6 +12,8 @@ Simulates that the next attempt to encode a [credential](../../../../capability- - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. -*** +--- ### `acs_credential_id` @@ -30,7 +32,7 @@ Required: No ID of the `acs_credential` that will fail to be encoded onto a card in the next request. -*** +--- ### `error_code` @@ -39,7 +41,10 @@ Required: No Code of the error to simulate. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index dd3a7fbee..475332155 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -12,6 +12,8 @@ Simulates that the next attempt to encode a [credential](../../../../capability- - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. -*** +--- ### `scenario` @@ -30,7 +32,10 @@ Required: No Scenario to simulate. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8a3333506..94c742b1b 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -12,6 +12,8 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. -*** +--- ### `acs_credential_id_on_seam` @@ -30,7 +32,7 @@ Required: No -*** +--- ### `error_code` @@ -39,7 +41,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 92f05df53..89ed40f74 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -12,6 +12,8 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. -*** +--- ### `acs_credential_id_on_seam` @@ -30,7 +32,7 @@ Required: No ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. -*** +--- ### `scenario` @@ -39,7 +41,10 @@ Required: No Scenario to simulate. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 8780c5597..3af47f2f2 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -141,6 +141,8 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance - API key - Client session token +--- + ## Request Parameters ### `acs_entrance_id` @@ -150,7 +152,10 @@ Required: Yes -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8ea04aa67..dd1c409a3 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -12,6 +12,8 @@ POST /acs/entrances/grant_access ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_entrance_id` @@ -21,7 +23,7 @@ Required: Yes -*** +--- ### `acs_user_id` @@ -30,7 +32,10 @@ Required: Yes -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 9e8696981..55d7b2890 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -141,6 +141,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -150,7 +152,7 @@ Required: No -*** +--- ### `acs_system_id` @@ -159,7 +161,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index f8d4dc4e1..dbe668d23 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -238,6 +238,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_entrance_id` @@ -247,7 +249,7 @@ Required: Yes -*** +--- ### `include_if` @@ -256,7 +258,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index c0eb0551f..7312d1729 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -117,6 +117,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -126,7 +128,10 @@ Required: Yes ID of the desired access control system. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 05a22b0e9..f9e1ae559 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -122,6 +122,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `connected_account_id` @@ -131,7 +133,10 @@ Required: No ID of the connected account by which to filter the list of returned access control systems. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 9338af5c1..aac19e202 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -125,6 +125,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -134,7 +136,10 @@ Required: Yes ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index c1da3c7fd..fa3bfe620 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index f7028e637..bd8dafe61 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -181,6 +181,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -190,7 +192,7 @@ Required: Yes ID of the `acs_system` to which to add the new `acs_user`. -*** +--- ### `full_name` @@ -199,7 +201,7 @@ Required: Yes Full name of the new `acs_user`. -*** +--- ### `access_schedule` @@ -208,7 +210,7 @@ Required: No `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. -*** +--- ### `acs_access_group_ids` @@ -217,7 +219,7 @@ Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. -*** +--- ### `email` @@ -226,7 +228,7 @@ Required: No -*** +--- ### `email_address` @@ -235,7 +237,7 @@ Required: No Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `phone_number` @@ -244,7 +246,7 @@ Required: No Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). -*** +--- ### `user_identity_id` @@ -253,13 +255,22 @@ Required: No ID of the user identity with which to associate the new `acs_user`. -*** +--- + + +--- ## Return Type [acs\_user](./) -## Additional Code Samples +--- + +## Code Samples + +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. {% tabs %} {% tab title="JavaScript" %} @@ -446,6 +457,10 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} +### Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + {% tabs %} {% tab title="JavaScript" %} #### Code diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index a4a6e7537..613c0cb44 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -114,6 +114,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -123,7 +125,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 08df27f88..992a2a826 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -160,6 +160,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -169,7 +171,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 630c4557b..0c6795b05 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -151,6 +151,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -160,7 +162,7 @@ Required: No ID of the `acs_system` for which you want to retrieve all `acs_user`s. -*** +--- ### `created_before` @@ -169,7 +171,7 @@ Required: No -*** +--- ### `limit` @@ -178,7 +180,7 @@ Required: No Maximum number of records to return per page. -*** +--- ### `page_cursor` @@ -187,7 +189,7 @@ Required: No Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. -*** +--- ### `search` @@ -196,7 +198,7 @@ Required: No String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. -*** +--- ### `user_identity_email_address` @@ -205,7 +207,7 @@ Required: No Email address of the user identity for which you want to retrieve all `acs_user`s. -*** +--- ### `user_identity_id` @@ -214,7 +216,7 @@ Required: No ID of the user identity for which you want to retrieve all `acs_user`s. -*** +--- ### `user_identity_phone_number` @@ -223,7 +225,10 @@ Required: No Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c5c4ad636..83b601fb4 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -13,6 +13,8 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -22,7 +24,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7e1b25f13..ea02c3db1 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 8a5357160..0792a2f91 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -12,6 +12,8 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -21,7 +23,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index bdb5eec73..82dd5a41d 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -114,6 +114,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -123,7 +125,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index eed957e5c..610f93d29 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -116,6 +116,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -125,7 +127,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index a9a5d70aa..e6feb1172 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -133,7 +135,7 @@ Required: Yes ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `access_schedule` @@ -142,7 +144,7 @@ Required: No `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. -*** +--- ### `email` @@ -151,7 +153,7 @@ Required: No -*** +--- ### `email_address` @@ -160,7 +162,7 @@ Required: No Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `full_name` @@ -169,7 +171,7 @@ Required: No Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `hid_acs_system_id` @@ -178,7 +180,7 @@ Required: No -*** +--- ### `phone_number` @@ -187,7 +189,10 @@ Required: No Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 00de709b3..ca23f0976 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -13,6 +13,8 @@ Deactivates a phone, which is useful, for example, if a user has lost their phon - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -22,7 +24,10 @@ Required: Yes Device ID of the desired phone. -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 1c06ba47a..ea2963010 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -12,6 +12,8 @@ Returns a single phone entry matching the provided `device_id`. - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -21,7 +23,10 @@ Required: Yes Device ID of the desired phone. -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index d0e79e40a..4c8f0ba27 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -12,6 +12,8 @@ Returns a list of all phones. To filter the list of returned phones by a specifi - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -21,7 +23,7 @@ Required: No ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. -*** +--- ### `owner_user_identity_id` @@ -30,7 +32,10 @@ Required: No ID of the user identity that represents the owner by which to filter the list of returned phones. -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index a1e393a65..69fb8abbb 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -12,6 +12,8 @@ Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/wo - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -21,7 +23,7 @@ Required: Yes ID of the user identity to associate with the simulated phone. -*** +--- ### `assa_abloy_metadata` @@ -30,7 +32,7 @@ Required: No ASSA ABLOY metadata to associate with the simulated phone. -*** +--- ### `custom_sdk_installation_id` @@ -39,7 +41,7 @@ Required: No ID of the custom SDK installation to use for the simulated phone. -*** +--- ### `phone_metadata` @@ -48,7 +50,10 @@ Required: No Metadata to associate with the simulated phone. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 0286eaca8..a2fcb370a 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -144,6 +144,8 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -153,7 +155,7 @@ Required: Yes Climate preset key of the desired climate preset. -*** +--- ### `device_id` @@ -162,7 +164,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index fd3f585c4..0ff1295c3 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -145,6 +145,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -154,7 +156,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `cooling_set_point_celsius` @@ -163,7 +165,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. -*** +--- ### `cooling_set_point_fahrenheit` @@ -172,7 +174,10 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 68f7aea65..919726dfb 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -155,6 +155,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -164,7 +166,7 @@ Required: Yes Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- ### `device_id` @@ -173,7 +175,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `cooling_set_point_celsius` @@ -182,7 +184,7 @@ Required: No Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `cooling_set_point_fahrenheit` @@ -191,7 +193,7 @@ Required: No Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `fan_mode_setting` @@ -200,7 +202,7 @@ Required: No Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. -*** +--- ### `heating_set_point_celsius` @@ -209,7 +211,7 @@ Required: No Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `heating_set_point_fahrenheit` @@ -218,7 +220,7 @@ Required: No Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `hvac_mode_setting` @@ -227,7 +229,7 @@ Required: No Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. -*** +--- ### `manual_override_allowed` @@ -236,7 +238,7 @@ Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings. -*** +--- ### `name` @@ -245,7 +247,10 @@ Required: No User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 1e11bfedd..6fbc71b8d 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -133,7 +135,7 @@ Required: Yes Climate preset key of the desired climate preset. -*** +--- ### `device_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 99d237be9..1c54b3347 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -145,6 +145,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -154,7 +156,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `heating_set_point_celsius` @@ -163,7 +165,7 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. -*** +--- ### `heating_set_point_fahrenheit` @@ -172,7 +174,10 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 7dd3535c7..5700f752e 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -151,6 +151,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -160,7 +162,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `cooling_set_point_celsius` @@ -169,7 +171,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. -*** +--- ### `cooling_set_point_fahrenheit` @@ -178,7 +180,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. -*** +--- ### `heating_set_point_celsius` @@ -187,7 +189,7 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. -*** +--- ### `heating_set_point_fahrenheit` @@ -196,7 +198,10 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 97e1d86ee..337639018 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -226,6 +226,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `connect_webview_id` @@ -235,7 +237,7 @@ Required: No ID of the Connect Webview by which to filter devices. -*** +--- ### `connected_account_id` @@ -244,7 +246,7 @@ Required: No ID of the connected account by which to filter. -*** +--- ### `connected_account_ids` @@ -253,7 +255,7 @@ Required: No Array of IDs of the connected accounts by which to filter devices. -*** +--- ### `created_before` @@ -262,7 +264,7 @@ Required: No Date threshold for devices to return. If specified, returns only devices created before the specified date. -*** +--- ### `custom_metadata_has` @@ -271,7 +273,7 @@ Required: No Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. -*** +--- ### `device_ids` @@ -280,7 +282,7 @@ Required: No Array of device IDs by which to filter devices. -*** +--- ### `device_type` @@ -289,7 +291,7 @@ Required: No Device type by which to filter devices. -*** +--- ### `device_types` @@ -298,7 +300,7 @@ Required: No Array of device types by which to filter devices. -*** +--- ### `limit` @@ -307,7 +309,7 @@ Required: No Numerical limit on the number of devices to return. -*** +--- ### `manufacturer` @@ -316,7 +318,7 @@ Required: No Manufacturer by which to filter devices. -*** +--- ### `user_identifier_key` @@ -325,7 +327,10 @@ Required: No Your own internal user ID for the user by which to filter devices. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index cdcf5f277..ab72399e6 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -135,6 +135,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -144,7 +146,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index b3a65ad48..01bb6825b 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -187,6 +187,8 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -196,7 +198,7 @@ Required: Yes Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. -*** +--- ### `device_id` @@ -205,7 +207,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `ends_at` @@ -214,7 +216,7 @@ Required: Yes Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `starts_at` @@ -223,7 +225,7 @@ Required: Yes Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `is_override_allowed` @@ -232,7 +234,7 @@ Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `max_override_period_minutes` @@ -241,7 +243,7 @@ Required: No Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `name` @@ -250,7 +252,10 @@ Required: No User-friendly name to identify the thermostat schedule. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index caba8dcec..6ab820dd6 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -119,6 +119,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `thermostat_schedule_id` @@ -128,7 +130,10 @@ Required: Yes ID of the desired thermostat schedule. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index ea58299fc..8f57ca677 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -160,6 +160,8 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `thermostat_schedule_id` @@ -169,7 +171,10 @@ Required: Yes ID of the desired thermostat schedule. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index eb7144bfe..fa858f60b 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -213,6 +213,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -222,7 +224,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `user_identifier_key` @@ -231,7 +233,10 @@ Required: No User identifier key by which to filter the list of returned thermostat schedules. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 2e3ed380d..856591728 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -126,6 +126,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `thermostat_schedule_id` @@ -135,7 +137,7 @@ Required: Yes ID of the desired thermostat schedule. -*** +--- ### `climate_preset_key` @@ -144,7 +146,7 @@ Required: No Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. -*** +--- ### `ends_at` @@ -153,7 +155,7 @@ Required: No Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `is_override_allowed` @@ -162,7 +164,7 @@ Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `max_override_period_minutes` @@ -171,7 +173,7 @@ Required: No Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `name` @@ -180,7 +182,7 @@ Required: No User-friendly name to identify the thermostat schedule. -*** +--- ### `starts_at` @@ -189,7 +191,10 @@ Required: No Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 7d005b9e8..fd61a735b 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -123,6 +123,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -132,7 +134,7 @@ Required: Yes Climate preset key of the desired climate preset. -*** +--- ### `device_id` @@ -141,7 +143,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index f168bf8d3..9a38e83c1 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -145,6 +145,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -154,7 +156,7 @@ Required: Yes -*** +--- ### `fan_mode` @@ -163,7 +165,7 @@ Required: No -*** +--- ### `fan_mode_setting` @@ -172,7 +174,10 @@ Required: No Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 4284c60a7..2da2a5f8e 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -156,6 +156,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -165,7 +167,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `hvac_mode_setting` @@ -174,7 +176,7 @@ Required: Yes -*** +--- ### `cooling_set_point_celsius` @@ -183,7 +185,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. -*** +--- ### `cooling_set_point_fahrenheit` @@ -192,7 +194,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. -*** +--- ### `heating_set_point_celsius` @@ -201,7 +203,7 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. -*** +--- ### `heating_set_point_fahrenheit` @@ -210,7 +212,10 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 739e33b13..5528dd9e6 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -129,6 +129,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -138,7 +140,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `lower_limit_celsius` @@ -147,7 +149,7 @@ Required: No Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. -*** +--- ### `lower_limit_fahrenheit` @@ -156,7 +158,7 @@ Required: No Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. -*** +--- ### `upper_limit_celsius` @@ -165,7 +167,7 @@ Required: No Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. -*** +--- ### `upper_limit_fahrenheit` @@ -174,7 +176,10 @@ Required: No Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 490f7e8a4..40cdbec07 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -12,6 +12,8 @@ Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -21,7 +23,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `hvac_mode` @@ -30,7 +32,7 @@ Required: Yes Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. -*** +--- ### `cooling_set_point_celsius` @@ -39,7 +41,7 @@ Required: No Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. -*** +--- ### `cooling_set_point_fahrenheit` @@ -48,7 +50,7 @@ Required: No Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. -*** +--- ### `heating_set_point_celsius` @@ -57,7 +59,7 @@ Required: No Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. -*** +--- ### `heating_set_point_fahrenheit` @@ -66,7 +68,10 @@ Required: No Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 467b35d50..0a8e4f423 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -12,6 +12,8 @@ Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermosta - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -21,7 +23,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `temperature_celsius` @@ -30,7 +32,7 @@ Required: No Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. -*** +--- ### `temperature_fahrenheit` @@ -39,7 +41,10 @@ Required: No Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 3c19b84de..25d0a289f 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -135,6 +135,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -144,7 +146,7 @@ Required: Yes Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- ### `device_id` @@ -153,7 +155,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `manual_override_allowed` @@ -162,7 +164,7 @@ Required: Yes Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `cooling_set_point_celsius` @@ -171,7 +173,7 @@ Required: No Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `cooling_set_point_fahrenheit` @@ -180,7 +182,7 @@ Required: No Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `fan_mode_setting` @@ -189,7 +191,7 @@ Required: No Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. -*** +--- ### `heating_set_point_celsius` @@ -198,7 +200,7 @@ Required: No Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `heating_set_point_fahrenheit` @@ -207,7 +209,7 @@ Required: No Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `hvac_mode_setting` @@ -216,7 +218,7 @@ Required: No Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. -*** +--- ### `name` @@ -225,7 +227,10 @@ Required: No User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index bd5301b5d..b297e03b5 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -133,7 +135,7 @@ Required: Yes ID of the desired ACS user. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 51ea9a19d..0e4072c77 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -180,6 +180,8 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `email_address` @@ -189,7 +191,7 @@ Required: No Unique email address for the user identity. -*** +--- ### `full_name` @@ -198,7 +200,7 @@ Required: No Full name of the user associated with the user identity. -*** +--- ### `phone_number` @@ -207,7 +209,7 @@ Required: No Unique phone number for the user identity in E.164 format (for example, +15555550100). -*** +--- ### `user_identity_key` @@ -216,7 +218,10 @@ Required: No Unique key for the user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 87696af33..ae0a623a9 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -115,6 +115,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -124,7 +126,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 775789e14..20f26b195 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -120,6 +120,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `enrollment_automation_id` @@ -129,7 +131,10 @@ Required: Yes ID of the desired enrollment automation. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 6d5c1bd19..04482654c 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -164,6 +164,8 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `enrollment_automation_id` @@ -173,7 +175,10 @@ Required: Yes ID of the desired enrollment automation. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 2f8592bb8..d1a3e342f 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -178,6 +178,8 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `credential_manager_acs_system_id` @@ -187,7 +189,7 @@ Required: Yes ID of the desired ACS system that serves as the credential manager. -*** +--- ### `user_identity_id` @@ -196,7 +198,7 @@ Required: Yes ID of the desired user identity. -*** +--- ### `acs_credential_pool_id` @@ -205,7 +207,7 @@ Required: No ID of the ACS credential pool from which to obtain credentials for the user identity. -*** +--- ### `create_credential_manager_user` @@ -214,7 +216,7 @@ Required: No Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. -*** +--- ### `credential_manager_acs_user_id` @@ -223,7 +225,10 @@ Required: No ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index a8714b3dc..0d01afedc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -174,6 +174,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -183,7 +185,10 @@ Required: Yes ID of the user identity for which you want to retrieve all enrollment automations. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 886a1925c..1e8d19f93 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -161,6 +161,8 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -170,7 +172,7 @@ Required: No ID of the desired user identity. -*** +--- ### `user_identity_key` @@ -179,7 +181,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 2e2471478..32e8a5851 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -133,7 +135,7 @@ Required: Yes ID of the desired managed device. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 1c778e2c0..345e7edfd 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -161,6 +161,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `credential_manager_acs_system_id` @@ -170,7 +172,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index a2a0cde8e..ba49e3469 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -391,6 +391,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -400,7 +402,10 @@ Required: Yes ID of the user identity for which you want to retrieve all accessible devices. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 04df25910..c8c2d2247 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -179,6 +179,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -188,7 +190,10 @@ Required: Yes ID of the user identity for which you want to retrieve all access control systems. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 1c0d08db1..029a3bfdf 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -188,6 +188,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -197,7 +199,10 @@ Required: Yes ID of the user identity for which you want to retrieve all ACS users. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e5583c1a2..372bdd303 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -133,7 +135,7 @@ Required: Yes ID of the ACS user. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 8613ef686..0b3266fbc 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -133,7 +135,7 @@ Required: Yes ID of the desired managed device. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d5deb5c99..06e734511 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -12,6 +12,8 @@ PATCH /user_identities/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -21,7 +23,7 @@ Required: Yes ID of the user identity. -*** +--- ### `email_address` @@ -30,7 +32,7 @@ Required: No Unique email address for the user identity. -*** +--- ### `full_name` @@ -39,7 +41,7 @@ Required: No -*** +--- ### `phone_number` @@ -48,7 +50,7 @@ Required: No Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). -*** +--- ### `user_identity_key` @@ -57,7 +59,10 @@ Required: No Unique key for the user identity. -*** +--- + + +--- ## Return Type From 6bcd338d06b2782bd38b8454201c012622f40834 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 17:46:31 -0400 Subject: [PATCH 33/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index b0385100a..8b3ef2d1d 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -42,8 +42,6 @@ None {{/if}} ---- - ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} From 2133a41b0ce7c609939b5250267236996a01beb2 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 21:47:34 +0000 Subject: [PATCH 34/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 2 -- docs/api/acs/access_groups/get.md | 2 -- docs/api/acs/access_groups/list.md | 2 -- docs/api/acs/access_groups/list_accessible_entrances.md | 2 -- docs/api/acs/access_groups/list_users.md | 2 -- docs/api/acs/access_groups/remove_user.md | 2 -- docs/api/acs/credentials/assign.md | 2 -- docs/api/acs/credentials/create.md | 2 -- docs/api/acs/credentials/delete.md | 2 -- docs/api/acs/credentials/get.md | 2 -- docs/api/acs/credentials/list.md | 2 -- docs/api/acs/credentials/list_accessible_entrances.md | 2 -- docs/api/acs/credentials/unassign.md | 2 -- docs/api/acs/credentials/update.md | 2 -- docs/api/acs/encoders/encode_credential.md | 2 -- docs/api/acs/encoders/list.md | 2 -- docs/api/acs/encoders/scan_credential.md | 2 -- .../acs/encoders/simulate/next_credential_encode_will_fail.md | 2 -- .../encoders/simulate/next_credential_encode_will_succeed.md | 2 -- .../api/acs/encoders/simulate/next_credential_scan_will_fail.md | 2 -- .../acs/encoders/simulate/next_credential_scan_will_succeed.md | 2 -- docs/api/acs/entrances/get.md | 2 -- docs/api/acs/entrances/grant_access.md | 2 -- docs/api/acs/entrances/list.md | 2 -- docs/api/acs/entrances/list_credentials_with_access.md | 2 -- docs/api/acs/systems/get.md | 2 -- docs/api/acs/systems/list.md | 2 -- .../systems/list_compatible_credential_manager_acs_systems.md | 2 -- docs/api/acs/users/add_to_access_group.md | 2 -- docs/api/acs/users/create.md | 2 -- docs/api/acs/users/delete.md | 2 -- docs/api/acs/users/get.md | 2 -- docs/api/acs/users/list.md | 2 -- docs/api/acs/users/list_accessible_entrances.md | 2 -- docs/api/acs/users/remove_from_access_group.md | 2 -- docs/api/acs/users/revoke_access_to_all_entrances.md | 2 -- docs/api/acs/users/suspend.md | 2 -- docs/api/acs/users/unsuspend.md | 2 -- docs/api/acs/users/update.md | 2 -- docs/api/phones/deactivate.md | 2 -- docs/api/phones/get.md | 2 -- docs/api/phones/list.md | 2 -- docs/api/phones/simulate/create_sandbox_phone.md | 2 -- docs/api/thermostats/activate_climate_preset.md | 2 -- docs/api/thermostats/cool.md | 2 -- docs/api/thermostats/create_climate_preset.md | 2 -- docs/api/thermostats/delete_climate_preset.md | 2 -- docs/api/thermostats/heat.md | 2 -- docs/api/thermostats/heat_cool.md | 2 -- docs/api/thermostats/list.md | 2 -- docs/api/thermostats/off.md | 2 -- docs/api/thermostats/schedules/create.md | 2 -- docs/api/thermostats/schedules/delete.md | 2 -- docs/api/thermostats/schedules/get.md | 2 -- docs/api/thermostats/schedules/list.md | 2 -- docs/api/thermostats/schedules/update.md | 2 -- docs/api/thermostats/set_fallback_climate_preset.md | 2 -- docs/api/thermostats/set_fan_mode.md | 2 -- docs/api/thermostats/set_hvac_mode.md | 2 -- docs/api/thermostats/set_temperature_threshold.md | 2 -- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 2 -- docs/api/thermostats/simulate/temperature_reached.md | 2 -- docs/api/thermostats/update_climate_preset.md | 2 -- docs/api/user_identities/add_acs_user.md | 2 -- docs/api/user_identities/create.md | 2 -- docs/api/user_identities/delete.md | 2 -- docs/api/user_identities/enrollment_automations/delete.md | 2 -- docs/api/user_identities/enrollment_automations/get.md | 2 -- docs/api/user_identities/enrollment_automations/launch.md | 2 -- docs/api/user_identities/enrollment_automations/list.md | 2 -- docs/api/user_identities/get.md | 2 -- docs/api/user_identities/grant_access_to_device.md | 2 -- docs/api/user_identities/list.md | 2 -- docs/api/user_identities/list_accessible_devices.md | 2 -- docs/api/user_identities/list_acs_systems.md | 2 -- docs/api/user_identities/list_acs_users.md | 2 -- docs/api/user_identities/remove_acs_user.md | 2 -- docs/api/user_identities/revoke_access_to_device.md | 2 -- docs/api/user_identities/update.md | 2 -- 79 files changed, 158 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 64b7cf53b..d280444f8 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 61eafdcc4..2cc9f6028 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -186,8 +186,6 @@ ID of the desired access group. --- ---- - ## Return Type [acs\_access\_group](./) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 8e5d846b6..e4b00a263 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -214,8 +214,6 @@ ID of the user for which you want to retrieve all access groups. --- ---- - ## Return Type Array<[acs\_access\_group](./)> diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 7c8e0ea1e..e7614ea60 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -180,8 +180,6 @@ ID of the access group for which you want to retrieve all accessible entrances. --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index be8fbb3fb..b75ca142d 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -238,8 +238,6 @@ ID of the access group for which you want to retrieve all users. --- ---- - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 20a359563..269906344 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index cff78cef3..80ce54802 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index e8f14d461..f7ee73c9e 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -317,8 +317,6 @@ Visionline-specific metadata for the new credential. --- ---- - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 21871a698..893f332d3 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -130,8 +130,6 @@ ID of the desired credential. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index cf4fcb86d..a03363f2b 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -181,8 +181,6 @@ ID of the desired credential. --- ---- - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index e2648b4c4..5e4d7fd59 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -256,8 +256,6 @@ ID of the user identity for which you want to retrieve all credentials. --- ---- - ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 040f8bc77..78f717d88 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -225,8 +225,6 @@ ID of the credential for which you want to retrieve all entrances to which this --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 8f47b4362..2836e6c0e 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 32c3ba597..a0317d2f4 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -153,8 +153,6 @@ Replacement date and time at which the validity of the credential ends, in [ISO --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 27b5cda02..ed011b840 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -35,8 +35,6 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index cc1cdc891..7d79694f7 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -53,8 +53,6 @@ Number of `acs_encoders` to return. --- ---- - ## Return Type Array<[acs\_encoder](./)> diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 95f13b6b2..a8f523438 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -26,8 +26,6 @@ ID of the `acs_encoder` to use for the scan. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 74ab12327..f754ff663 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -44,8 +44,6 @@ Code of the error to simulate. --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 475332155..ff43764bf 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -35,8 +35,6 @@ Scenario to simulate. --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 94c742b1b..28489b42e 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -44,8 +44,6 @@ Required: No --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 89ed40f74..3e2eb3bc3 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -44,8 +44,6 @@ Scenario to simulate. --- ---- - ## Return Type void diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 3af47f2f2..9c06b62fe 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -155,8 +155,6 @@ Required: Yes --- ---- - ## Return Type [acs\_entrance](./) diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index dd1c409a3..86f7acef7 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -35,8 +35,6 @@ Required: Yes --- ---- - ## Return Type void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 55d7b2890..0c7d45151 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -164,8 +164,6 @@ Required: No --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index dbe668d23..faab439d2 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -261,8 +261,6 @@ Required: No --- ---- - ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 7312d1729..d5bb5f40d 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -131,8 +131,6 @@ ID of the desired access control system. --- ---- - ## Return Type [acs\_system](./) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index f9e1ae559..801c08d5f 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -136,8 +136,6 @@ ID of the connected account by which to filter the list of returned access contr --- ---- - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index aac19e202..054e53f4c 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -139,8 +139,6 @@ ID of the ACS system for which you want to retrieve all compatible credential ma --- ---- - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index fa3bfe620..0740c2a68 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -148,8 +148,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index bd8dafe61..5adddb825 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -258,8 +258,6 @@ ID of the user identity with which to associate the new `acs_user`. --- ---- - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 613c0cb44..a1fbaf153 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -128,8 +128,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 992a2a826..6fb9a9103 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -174,8 +174,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 0c6795b05..c83996f19 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -228,8 +228,6 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s --- ---- - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 83b601fb4..e67a8abea 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -27,8 +27,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index ea02c3db1..007c9bec9 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -148,8 +148,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 0792a2f91..583a2532b 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -26,8 +26,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 82dd5a41d..c84182810 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -128,8 +128,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 610f93d29..00064209a 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -130,8 +130,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index e6feb1172..4e2866bcd 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -192,8 +192,6 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- ---- - ## Return Type void diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index ca23f0976..f160a5fdb 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -27,8 +27,6 @@ Device ID of the desired phone. --- ---- - ## Return Type void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index ea2963010..8d1166c18 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -26,8 +26,6 @@ Device ID of the desired phone. --- ---- - ## Return Type [phone](./) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 4c8f0ba27..e85c3aba1 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,8 +35,6 @@ ID of the user identity that represents the owner by which to filter the list of --- ---- - ## Return Type Array<[phone](./)> diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 69fb8abbb..c6ef24d60 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -53,8 +53,6 @@ Metadata to associate with the simulated phone. --- ---- - ## Return Type [phone](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index a2fcb370a..4a76e9bf7 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -167,8 +167,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 0ff1295c3..834cec24c 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -177,8 +177,6 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 919726dfb..0d93d5898 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -250,8 +250,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- ---- - ## Return Type void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 6fbc71b8d..13dd99c46 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -147,8 +147,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 1c54b3347..0ee93ebd8 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -177,8 +177,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 5700f752e..acf0ee0fa 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -201,8 +201,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 337639018..ed07f77cc 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -330,8 +330,6 @@ Your own internal user ID for the user by which to filter devices. --- ---- - ## Return Type Array<[device](./)> diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index ab72399e6..07e778ab1 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -149,8 +149,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 01bb6825b..2749a96e8 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -255,8 +255,6 @@ User-friendly name to identify the thermostat schedule. --- ---- - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 6ab820dd6..6b64d3d23 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -133,8 +133,6 @@ ID of the desired thermostat schedule. --- ---- - ## Return Type void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 8f57ca677..102f9e1ef 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -174,8 +174,6 @@ ID of the desired thermostat schedule. --- ---- - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index fa858f60b..dddd3fafa 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -236,8 +236,6 @@ User identifier key by which to filter the list of returned thermostat schedules --- ---- - ## Return Type Array<[thermostat\_schedule](./)> diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 856591728..2b7c2af5a 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -194,8 +194,6 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www --- ---- - ## Return Type void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index fd61a735b..362676b36 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -146,8 +146,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 9a38e83c1..5a88879c2 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -177,8 +177,6 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 2da2a5f8e..82dbc09dd 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -215,8 +215,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 5528dd9e6..b7b4d24ac 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -179,8 +179,6 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i --- ---- - ## Return Type void diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 40cdbec07..11b27a62d 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -71,8 +71,6 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und --- ---- - ## Return Type void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 0a8e4f423..66a10e442 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -44,8 +44,6 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` --- ---- - ## Return Type void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 25d0a289f..3e56936f9 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -230,8 +230,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- ---- - ## Return Type void diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index b297e03b5..52ed3a60d 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 0e4072c77..07eda4a0a 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -221,8 +221,6 @@ Unique key for the user identity. --- ---- - ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index ae0a623a9..2f56d236e 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -129,8 +129,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 20f26b195..e914ebc3e 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -134,8 +134,6 @@ ID of the desired enrollment automation. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 04482654c..ee922cf72 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -178,8 +178,6 @@ ID of the desired enrollment automation. --- ---- - ## Return Type [enrollment\_automation](./) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index d1a3e342f..8ca8fb9d4 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -228,8 +228,6 @@ ID of the associated ACS user within the credential manager. If you specify a `c --- ---- - ## Return Type [unknown](./) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 0d01afedc..7e8901f8f 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -188,8 +188,6 @@ ID of the user identity for which you want to retrieve all enrollment automation --- ---- - ## Return Type Array<[enrollment\_automation](./)> diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 1e8d19f93..e5af4532e 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -184,8 +184,6 @@ Required: No --- ---- - ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 32e8a5851..c7fea2e76 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 345e7edfd..68bd99c01 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -175,8 +175,6 @@ Required: No --- ---- - ## Return Type Array<[user\_identity](./)> diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index ba49e3469..2b9f6c65c 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -405,8 +405,6 @@ ID of the user identity for which you want to retrieve all accessible devices. --- ---- - ## Return Type Array<[device](./)> diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index c8c2d2247..ed32673e6 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -193,8 +193,6 @@ ID of the user identity for which you want to retrieve all access control system --- ---- - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 029a3bfdf..fc84f52bc 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -202,8 +202,6 @@ ID of the user identity for which you want to retrieve all ACS users. --- ---- - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 372bdd303..663270462 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 0b3266fbc..0d8590456 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 06e734511..742e986f3 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -62,8 +62,6 @@ Unique key for the user identity. --- ---- - ## Return Type void From 3c9bfdcf4b3ed22ae7599cb3bb89c1fef4a663bc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 17:51:06 -0400 Subject: [PATCH 35/60] Add access codes to gen --- src/lib/reference.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/lib/reference.ts b/src/lib/reference.ts index b6da756fa..0ebf2e09a 100644 --- a/src/lib/reference.ts +++ b/src/lib/reference.ts @@ -56,7 +56,8 @@ export const reference = ( !route.path.startsWith('/acs') && !route.path.startsWith('/thermostats') && !route.path.startsWith('/phones') && - !route.path.startsWith('/user_identities') + !route.path.startsWith('/user_identities') && + !route.path.startsWith('/access_codes') ) { continue } From 49a69123f322c3dd032c11a3b6b561910c9cf822 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 17:53:52 -0400 Subject: [PATCH 36/60] Add access codes to gen --- src/data/paths.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 4b9238aaa..94caa45c4 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -80,3 +80,8 @@ title: Enrollment Automations resources: - enrollment_automation + +/access_codes: + title: Access Codes + resources: + - access_code From d9f3c175435ee516339397ea055c95df6c418eba Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 21:54:49 +0000 Subject: [PATCH 37/60] ci: Generate docs --- docs/api/_report.md | 1 - docs/api/access_codes/README.md | 1690 +++++++++++++++++++++++++++++++ 2 files changed, 1690 insertions(+), 1 deletion(-) create mode 100644 docs/api/access_codes/README.md diff --git a/docs/api/_report.md b/docs/api/_report.md index 937adb7e7..840dcc6c7 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -4,7 +4,6 @@ ### Routes -- `/access_codes` - `/access_codes/simulate` - `/access_codes/unmanaged` - `/action_attempts` diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md new file mode 100644 index 000000000..34a356bf0 --- /dev/null +++ b/docs/api/access_codes/README.md @@ -0,0 +1,1690 @@ +# Access Codes + +The Access Codes route contains the following resources: + +## The `access_code` Resource + +## Properties + +### `access_code_id` + +Format: `UUID` + +Unique identifier for the access code. + +--- + +### `code` + +Format: `String` + +Code used for access. Typically, a numeric or alphanumeric string. + +--- + +### `common_code_key` + +Format: `String` + +Unique identifier for a group of access codes that share the same code. + +--- + +### `created_at` + +Format: `Datetime` + +Date and time at which the access code was created. + +--- + +### `device_id` + +Format: `UUID` + +Unique identifier for the device associated with the access code. + +--- + +### `ends_at` + +Format: `Datetime` + +Date and time after which the time-bound access code becomes inactive. + +--- + +### [`errors`](./#errors-1) + +Format: `List` + +Item format: `Object` + +Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. + +--- + +### `is_backup` + +Format: `Boolean` + +Indicates whether the access code is a backup code. + +--- + +### `is_backup_access_code_available` + +Format: `Boolean` + +Indicates whether a backup access code is available for use if the primary access code is lost or compromised. + +--- + +### `is_external_modification_allowed` + +Format: `Boolean` + +Indicates whether changes to the access code from external sources are permitted. + +--- + +### `is_managed` + +Format: `Boolean` + +Indicates whether Seam manages the access code. + +--- + +### `is_offline_access_code` + +Format: `Boolean` + +Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. + +--- + +### `is_one_time_use` + +Format: `Boolean` + +Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. + +--- + +### `is_scheduled_on_device` + +Format: `Boolean` + +Indicates whether the code is set on the device according to a preconfigured schedule. + +--- + +### `is_waiting_for_code_assignment` + +Format: `Boolean` + +Indicates whether the access code is waiting for a code assignment. + +--- + +### `name` + +Format: `String` + +Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + +--- + +### `pulled_backup_access_code_id` + +Format: `UUID` + +Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. + +--- + +### `starts_at` + +Format: `Datetime` + +Date and time at which the time-bound access code becomes active. + +--- + +### `status` + +Format: `Enum` + + + Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. + + +Possible enum values: +- `setting` +- `set` +- `unset` +- `removing` +- `unknown` + +--- + +### `type` + +Format: `Enum` + +Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. + +Possible enum values: +- `time_bound` +- `ongoing` + +--- + +### [`warnings`](./#warnings-1) + +Format: `List` + +Item format: `Object` + +Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. + +--- + +## Errors + +### `smartthings_failed_to_set_access_code` + +Failed to set code on Smart Things device. + +--- + +### `smartthings_failed_to_set_after_multiple_retries` + +Failed to set code after multiple retries. + +--- + +### `smartthings_no_free_slots_available` + +No free slots available on the device. + +--- + +### `failed_to_set_on_device` + +Failed to set code on device. + +--- + +### `failed_to_remove_from_device` + +Failed to remove code from device. + +--- + +### `duplicate_code_on_device` + +Duplicate access code detected on device. + +--- + +### `duplicate_code_attempt_prevented` + +An attempt to modify this access code was prevented. + +--- + +### `igloohome_bridge_too_many_pending_jobs` + +Igloohome bridge has too many pending jobs in the queue. + +--- + +### `igloohome_bridge_offline` + +Igloohome bridge is offline. + +--- + +### `igloohome_offline_access_code_no_variance_available` + +Lock as reached max amount of codes. + +--- + +### `kwikset_unable_to_confirm_code` + +Unable to confirm the access code is set on Kwikset device. + +--- + +### `kwikset_unable_to_confirm_deletion` + +Unable to confirm the deletion of the access code on Kwikset device. + +--- + +### `code_modified_external_to_seam` + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +### `august_lock_invalid_code_length` + +Invalid code length for August lock. + +--- + +### `august_device_programming_delay` + +Access code has not yet been fully moved to the device. + +--- + +### `august_device_slots_full` + +All access code slots on the device are full. + +--- + +### `august_lock_missing_keypad` + +August lock is missing a keypad. + +--- + +### `august_lock_temporarily_offline` + +August lock is temporarily offline. + +--- + +### `salto_ks_user_not_subscribed` + +Salto site user is not subscribed. + +--- + +### `hubitat_device_programming_delay` + +Access code has not yet been fully moved to the device. + +--- + +### `hubitat_no_free_positions_available` + +No free positions available on the device. + +--- + +### `wyze_duplicate_code_name` + +Duplicate access code name detected. + +--- + +### `wyze_potential_duplicate_code` + +Potential duplicate access code detected. + +--- + +### `dormakaba_oracode_no_valid_user_level` + +No valid user level for Oracode. + +--- + +### `account_disconnected` + +Account is disconnected + +--- + +### `salto_ks_subscription_limit_exceeded` + +Salto site user limit reached. + +--- + +### `device_offline` + +Device is offline + +--- + +### `device_removed` + +Device has been removed + +--- + +### `hub_disconnected` + +Hub is disconnected + +--- + +### `device_disconnected` + +Device is disconnected + +--- + +### `empty_backup_access_code_pool` + +The backup access code pool is empty. + +--- + +### `august_lock_not_authorized` + +User is not authorized to use the August Lock. + +--- + +### `august_lock_missing_bridge` + +Lock is not connected to the Seam Bridge. + +--- + +### `ttlock_lock_not_paired_to_gateway` + +Lock is not paired with a Gateway. + +--- + +### `missing_device_credentials` + +Missing device credentials. + +--- + +### `auxiliary_heat_running` + +The auxiliary heat is running. + +--- + +### `subscription_required` + +Subscription required to connect. + +--- + +### `invalid_credentials` + +Credentials provided were invalid. + +--- + +## Warnings + +### `smartthings_failed_to_set_access_code` + +Failed to set code on Smart Things device. + +--- + +### `schlage_detected_duplicate` + +Duplicate access code detected. + +--- + +### `schlage_creation_outage` + +Received an error when attempting to create this code. + +--- + +### `code_modified_external_to_seam` + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +### `delay_in_setting_on_device` + +Delay in setting code on device. + +--- + +### `delay_in_removing_from_device` + +Delay in removing code from device. + +--- + +### `third_party_integration_detected` + +Third party integration detected that may cause access codes to fail. + +--- + +### `august_device_programming_delay` + +Access code has not yet been fully moved to the device. + +--- + +### `august_lock_temporarily_offline` + +August lock is temporarily offline. + +--- + +### `igloo_algopin_must_be_used_within_24_hours` + +Algopins must be used within 24 hours. + +--- + +### `management_transferred` + +Management was transferred to another workspace. + +--- + +### `kwikset_unable_to_confirm_code` + +Unable to confirm the access code is set on Kwikset device. + +--- + +## Endpoints + + +--- + +## Events + +### `access_code.created` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.changed` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.scheduled_on_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +code Format: String + +Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.set_on_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +code Format: String + +Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.removed_from_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.delay_in_setting_on_device` + +There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.failed_to_set_on_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.deleted` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +code Format: String + +Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.delay_in_removing_from_device` + +There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.failed_to_remove_from_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.modified_external_to_seam` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.deleted_external_to_seam` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.backup_access_code_pulled` + +A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +backup_access_code_id Format: String + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.unmanaged.converted_to_managed` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.unmanaged.failed_to_convert_to_managed` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.unmanaged.created` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + +### `access_code.unmanaged.removed` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). + +
+ +
+ +created_at Format: Datetime + +Date and time at which the event was created. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. + +
+ +
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). + +
+ +--- + From 4d1969175b8d1349ae4173931e510913cbf2d1c0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 18:40:49 -0400 Subject: [PATCH 38/60] Alphabetize SUMMARY.md --- docs/SUMMARY.md | 82 ++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 6b56272d6..e0b72de26 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -126,36 +126,6 @@ * [Overview](api-clients/overview.md) * [Installation](api-clients/installation.md) * [Authentication](api-clients/authentication.md) -* [Workspaces](api-clients/workspaces/README.md) - * [Get Workspace](api-clients/workspaces/get.md) - * [Reset Workspace](api-clients/workspaces/reset_sandbox.md) -* [Client Sessions](api-clients/client_sessions/README.md) - * [Create a Client Session](api-clients/client_sessions/create.md) - * [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md) - * [List Client Sessions](api-clients/client_sessions/list.md) - * [Get a Client Session](api-clients/client_sessions/get.md) - * [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md) - * [Delete a Client Session](api-clients/client_sessions/delete.md) -* [Connect Webviews](api-clients/connect_webviews/README.md) - * [Create a Connect Webview](api-clients/connect_webviews/create.md) - * [List Connect Webviews](api-clients/connect_webviews/list.md) - * [Get a Connect Webview](api-clients/connect_webviews/get.md) - * [Delete a Connect Webview](api-clients/connect_webviews/delete.md) -* [Connected Accounts](api-clients/connected_accounts/README.md) - * [Get a Connected Account](api-clients/connected_accounts/get.md) - * [List Connected Accounts](api-clients/connected_accounts/list.md) - * [Update a Connected Account](api-clients/connected_accounts/update.md) - * [Delete a Connected Account](api-clients/connected_accounts/delete.md) -* [Devices](api-clients/devices/README.md) - * [List Devices](api-clients/devices/list.md) - * [List Device Providers](api-clients/devices/list_device_providers.md) - * [Device Provider Metadata](reference/device-provider-metadata.md) - * [Get a Device](api-clients/devices/get.md) - * [Update a Device](api-clients/devices/update.md) - * [Unmanaged Devices](api-clients/devices/unmanaged/README.md) - * [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md) - * [List Unmanaged Devices](api-clients/devices/unmanaged/list.md) - * [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md) * [Access Codes](api-clients/access_codes/README.md) * [Create an Access Code](api-clients/access_codes/create.md) * [Create Multiple Linked Access Codes](api-clients/access_codes/create_multiple.md) @@ -169,12 +139,7 @@ * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) -* [Locks](api-clients/locks/README.md) - * [Get Lock](api-clients/locks/get.md) - * [Lock a Lock](api-clients/locks/lock_door.md) - * [Unlock a Lock](api-clients/locks/unlock_door.md) - * [List Locks](api-clients/locks/list.md) -* [Access Control Systems](api/acs/README.md) +* [Access Control Systems (ACS)](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) * [Get an ACS System](api/acs/systems/get.md) @@ -217,6 +182,43 @@ * [Simulate that the Next Credential Encoding Will Succeed](api/acs/encoders/simulate/next_credential_encode_will_succeed.md) * [Simulate that the Next Credential Scan Will Fail](api/acs/encoders/simulate/next_credential_scan_will_fail.md) * [Simulate that the Next Credential Scan Will Succeed](api/acs/encoders/simulate/next_credential_scan_will_succeed.md) +* [Action Attempts](api-clients/action_attempts/README.md) + * [Get Action Attempt](api-clients/action_attempts/get.md) +* [Client Sessions](api-clients/client_sessions/README.md) + * [Create a Client Session](api-clients/client_sessions/create.md) + * [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md) + * [List Client Sessions](api-clients/client_sessions/list.md) + * [Get a Client Session](api-clients/client_sessions/get.md) + * [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md) + * [Delete a Client Session](api-clients/client_sessions/delete.md) +* [Connect Webviews](api-clients/connect_webviews/README.md) + * [Create a Connect Webview](api-clients/connect_webviews/create.md) + * [List Connect Webviews](api-clients/connect_webviews/list.md) + * [Get a Connect Webview](api-clients/connect_webviews/get.md) + * [Delete a Connect Webview](api-clients/connect_webviews/delete.md) +* [Connected Accounts](api-clients/connected_accounts/README.md) + * [Get a Connected Account](api-clients/connected_accounts/get.md) + * [List Connected Accounts](api-clients/connected_accounts/list.md) + * [Update a Connected Account](api-clients/connected_accounts/update.md) + * [Delete a Connected Account](api-clients/connected_accounts/delete.md) +* [Devices](api-clients/devices/README.md) + * [List Devices](api-clients/devices/list.md) + * [List Device Providers](api-clients/devices/list_device_providers.md) + * [Device Provider Metadata](reference/device-provider-metadata.md) + * [Get a Device](api-clients/devices/get.md) + * [Update a Device](api-clients/devices/update.md) + * [Unmanaged Devices](api-clients/devices/unmanaged/README.md) + * [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md) + * [List Unmanaged Devices](api-clients/devices/unmanaged/list.md) + * [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md) +* [Events](api-clients/events/README.md) + * [List Events](api-clients/events/list.md) + * [Get an Event](api-clients/events/get.md) +* [Locks](api-clients/locks/README.md) + * [Get Lock](api-clients/locks/get.md) + * [Lock a Lock](api-clients/locks/lock_door.md) + * [Unlock a Lock](api-clients/locks/unlock_door.md) + * [List Locks](api-clients/locks/list.md) * [Noise Sensors](api-clients/noise_sensors/README.md) * [Noise Thresholds](api-clients/noise_sensors/noise_thresholds/README.md) * [Create Noise Thresholds](api-clients/noise_sensors/noise_thresholds/create.md) @@ -270,11 +272,9 @@ * [List Enrollment Automations](api/user_identities/enrollment_automations/list.md) * [Get an Enrollment Automation](api/user_identities/enrollment_automations/get.md) * [Delete an Enrollment Automation](api/user_identities/enrollment_automations/delete.md) -* [Action Attempts](api-clients/action_attempts/README.md) - * [Get Action Attempt](api-clients/action_attempts/get.md) -* [Events](api-clients/events/README.md) - * [List Events](api-clients/events/list.md) - * [Get an Event](api-clients/events/get.md) +* [Workspaces](api-clients/workspaces/README.md) + * [Get Workspace](api-clients/workspaces/get.md) + * [Reset Workspace](api-clients/workspaces/reset_sandbox.md) ## 🛠️ Developer Tools From 1d386346fbd84bdb978dc783a6f3b450fe3c5faf Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 18:43:04 -0400 Subject: [PATCH 39/60] Update paths.yaml --- src/data/paths.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 94caa45c4..59ffc89a8 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -1,6 +1,6 @@ --- /acs: - title: Access Control Systems + title: Access Control Systems (ACS) description: Systems for managing and monitoring access to physical spaces overview: | Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 4d0a5429a939efa14ea3e6edfa6f709253d1f0ca Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 22:44:13 +0000 Subject: [PATCH 40/60] ci: Generate docs --- docs/api/acs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index b6244626e..78c99bd4b 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems +# Access Control Systems (ACS) Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,7 +21,7 @@ To grant access using the Seam access control system API, use the following basi ## Resources -The Access Control Systems namespace contains the following resources: +The Access Control Systems (ACS) namespace contains the following resources: ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From bd2a0adf40488c4590b263f92060eee92ef64767 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 19:21:21 -0400 Subject: [PATCH 41/60] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 8b3ef2d1d..114b48fb7 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -1,8 +1,12 @@ # {{title}} +{% tabs %} +{% tab title="Signature" %} ``` {{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}} ``` +{% endtab %} +{% endtabs %} {{{description}}} From 5bf47d6fa170f83f1d4da944669cc8fce31e838c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 23:22:19 +0000 Subject: [PATCH 42/60] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 4 ++++ docs/api/acs/access_groups/get.md | 4 ++++ docs/api/acs/access_groups/list.md | 4 ++++ docs/api/acs/access_groups/list_accessible_entrances.md | 4 ++++ docs/api/acs/access_groups/list_users.md | 4 ++++ docs/api/acs/access_groups/remove_user.md | 4 ++++ docs/api/acs/credentials/assign.md | 4 ++++ docs/api/acs/credentials/create.md | 4 ++++ docs/api/acs/credentials/delete.md | 4 ++++ docs/api/acs/credentials/get.md | 4 ++++ docs/api/acs/credentials/list.md | 4 ++++ docs/api/acs/credentials/list_accessible_entrances.md | 4 ++++ docs/api/acs/credentials/unassign.md | 4 ++++ docs/api/acs/credentials/update.md | 4 ++++ docs/api/acs/encoders/encode_credential.md | 4 ++++ docs/api/acs/encoders/list.md | 4 ++++ docs/api/acs/encoders/scan_credential.md | 4 ++++ .../acs/encoders/simulate/next_credential_encode_will_fail.md | 4 ++++ .../encoders/simulate/next_credential_encode_will_succeed.md | 4 ++++ .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 ++++ .../encoders/simulate/next_credential_scan_will_succeed.md | 4 ++++ docs/api/acs/entrances/get.md | 4 ++++ docs/api/acs/entrances/grant_access.md | 4 ++++ docs/api/acs/entrances/list.md | 4 ++++ docs/api/acs/entrances/list_credentials_with_access.md | 4 ++++ docs/api/acs/systems/get.md | 4 ++++ docs/api/acs/systems/list.md | 4 ++++ .../systems/list_compatible_credential_manager_acs_systems.md | 4 ++++ docs/api/acs/users/add_to_access_group.md | 4 ++++ docs/api/acs/users/create.md | 4 ++++ docs/api/acs/users/delete.md | 4 ++++ docs/api/acs/users/get.md | 4 ++++ docs/api/acs/users/list.md | 4 ++++ docs/api/acs/users/list_accessible_entrances.md | 4 ++++ docs/api/acs/users/remove_from_access_group.md | 4 ++++ docs/api/acs/users/revoke_access_to_all_entrances.md | 4 ++++ docs/api/acs/users/suspend.md | 4 ++++ docs/api/acs/users/unsuspend.md | 4 ++++ docs/api/acs/users/update.md | 4 ++++ docs/api/phones/deactivate.md | 4 ++++ docs/api/phones/get.md | 4 ++++ docs/api/phones/list.md | 4 ++++ docs/api/phones/simulate/create_sandbox_phone.md | 4 ++++ docs/api/thermostats/activate_climate_preset.md | 4 ++++ docs/api/thermostats/cool.md | 4 ++++ docs/api/thermostats/create_climate_preset.md | 4 ++++ docs/api/thermostats/delete_climate_preset.md | 4 ++++ docs/api/thermostats/heat.md | 4 ++++ docs/api/thermostats/heat_cool.md | 4 ++++ docs/api/thermostats/list.md | 4 ++++ docs/api/thermostats/off.md | 4 ++++ docs/api/thermostats/schedules/create.md | 4 ++++ docs/api/thermostats/schedules/delete.md | 4 ++++ docs/api/thermostats/schedules/get.md | 4 ++++ docs/api/thermostats/schedules/list.md | 4 ++++ docs/api/thermostats/schedules/update.md | 4 ++++ docs/api/thermostats/set_fallback_climate_preset.md | 4 ++++ docs/api/thermostats/set_fan_mode.md | 4 ++++ docs/api/thermostats/set_hvac_mode.md | 4 ++++ docs/api/thermostats/set_temperature_threshold.md | 4 ++++ docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 ++++ docs/api/thermostats/simulate/temperature_reached.md | 4 ++++ docs/api/thermostats/update_climate_preset.md | 4 ++++ docs/api/user_identities/add_acs_user.md | 4 ++++ docs/api/user_identities/create.md | 4 ++++ docs/api/user_identities/delete.md | 4 ++++ docs/api/user_identities/enrollment_automations/delete.md | 4 ++++ docs/api/user_identities/enrollment_automations/get.md | 4 ++++ docs/api/user_identities/enrollment_automations/launch.md | 4 ++++ docs/api/user_identities/enrollment_automations/list.md | 4 ++++ docs/api/user_identities/get.md | 4 ++++ docs/api/user_identities/grant_access_to_device.md | 4 ++++ docs/api/user_identities/list.md | 4 ++++ docs/api/user_identities/list_accessible_devices.md | 4 ++++ docs/api/user_identities/list_acs_systems.md | 4 ++++ docs/api/user_identities/list_acs_users.md | 4 ++++ docs/api/user_identities/remove_acs_user.md | 4 ++++ docs/api/user_identities/revoke_access_to_device.md | 4 ++++ docs/api/user_identities/update.md | 4 ++++ 79 files changed, 316 insertions(+) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index d280444f8..2805c6a65 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -1,8 +1,12 @@ # Add an ACS User to an Access Group +{% tabs %} +{% tab title="Signature" %} ``` PUT /acs/access_groups/add_user ⇒ void ``` +{% endtab %} +{% endtabs %} Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 2cc9f6028..73fe16bf4 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -1,8 +1,12 @@ # Get an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/get ⇒ { acs_access_group } ``` +{% endtab %} +{% endtabs %} Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index e4b00a263..01e436a12 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -1,8 +1,12 @@ # List Access Groups +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index e7614ea60..bbd65b0d0 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -1,8 +1,12 @@ # List Entrances Accessible to an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index b75ca142d..f151a3acb 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -1,8 +1,12 @@ # List ACS Users in an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 269906344..d417a68c9 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -1,8 +1,12 @@ # Remove an ACS User from an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/remove_user ⇒ void ``` +{% endtab %} +{% endtabs %} Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 80ce54802..fc98593dc 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -1,8 +1,12 @@ # Assign a Credential to an ACS User +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/assign ⇒ void ``` +{% endtab %} +{% endtabs %} Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index f7ee73c9e..1c39f1422 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -1,8 +1,12 @@ # Create a Credential for an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/create ⇒ { acs_credential } ``` +{% endtab %} +{% endtabs %} Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 893f332d3..9d00c4d61 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -1,8 +1,12 @@ # Delete a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index a03363f2b..1e44ed30c 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -1,8 +1,12 @@ # Get a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/get ⇒ { acs_credential } ``` +{% endtab %} +{% endtabs %} Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 5e4d7fd59..1a4e19719 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -1,8 +1,12 @@ # List Credentials +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 78f717d88..45809e06e 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -1,8 +1,12 @@ # List Accessible Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 2836e6c0e..283af8293 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -1,8 +1,12 @@ # Unassign a Credential from an ACS User +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/unassign ⇒ void ``` +{% endtab %} +{% endtabs %} Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index a0317d2f4..02e3e0ad3 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -1,8 +1,12 @@ # Update a Credential +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/update ⇒ void ``` +{% endtab %} +{% endtabs %} Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index ed011b840..613b48bba 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -1,8 +1,12 @@ # Encode a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 7d79694f7..4802c7db8 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -1,8 +1,12 @@ # List Encoders +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index a8f523438..3406a5566 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -1,8 +1,12 @@ # Scan a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index f754ff663..3ad65d74a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Encoding Will Fail +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index ff43764bf..9843a3308 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Encoding Will Succeed +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 28489b42e..45a7dd81c 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Scan Will Fail +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 3e2eb3bc3..da97c97b6 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Scan Will Succeed +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 9c06b62fe..4c96237ac 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -1,8 +1,12 @@ # Get an Entrance +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/get ⇒ { acs_entrance } ``` +{% endtab %} +{% endtabs %} Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 86f7acef7..33b243769 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -1,8 +1,12 @@ # Grant an ACS User Access to an Entrance +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/grant_access ⇒ void ``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 0c7d45151..3503d3f87 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -1,8 +1,12 @@ # List Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index faab439d2..7508d01fb 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -1,8 +1,12 @@ # List Credentials with Access to an Entrance +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index d5bb5f40d..4f1dfa2e1 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -1,8 +1,12 @@ # Get an ACS System +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/get ⇒ { acs_system } ``` +{% endtab %} +{% endtabs %} Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 801c08d5f..97a2230ce 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -1,8 +1,12 @@ # List ACS Systems +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 054e53f4c..460818a89 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -1,8 +1,12 @@ # List Compatible Credential Manager ACS Systems +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 0740c2a68..3751d076a 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -1,8 +1,12 @@ # Add an ACS User to an Access Group +{% tabs %} +{% tab title="Signature" %} ``` PUT /acs/users/add_to_access_group ⇒ void ``` +{% endtab %} +{% endtabs %} Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 5adddb825..99595aedd 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -1,8 +1,12 @@ # Create an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/create ⇒ { acs_user } ``` +{% endtab %} +{% endtabs %} Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index a1fbaf153..01963fadb 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -1,8 +1,12 @@ # Delete an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 6fb9a9103..79acfe5ce 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -1,8 +1,12 @@ # Get an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/get ⇒ { acs_user } ``` +{% endtab %} +{% endtabs %} Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index c83996f19..d65058142 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -1,8 +1,12 @@ # List ACS Users +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index e67a8abea..246d70a5f 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -1,8 +1,12 @@ # List ACS User-Accessible Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 007c9bec9..119aba347 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -1,8 +1,12 @@ # Remove an ACS User from an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/remove_from_access_group ⇒ void ``` +{% endtab %} +{% endtabs %} Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 583a2532b..fff46237a 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -1,8 +1,12 @@ # Revoke ACS User Access to All Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` +{% endtab %} +{% endtabs %} Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index c84182810..1e68cbf71 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -1,8 +1,12 @@ # Suspend an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/suspend ⇒ void ``` +{% endtab %} +{% endtabs %} [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 00064209a..4b18eb838 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -1,8 +1,12 @@ # Unsuspend an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/unsuspend ⇒ void ``` +{% endtab %} +{% endtabs %} [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 4e2866bcd..0cbbdae60 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -1,8 +1,12 @@ # Update an ACS User +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/users/update ⇒ void ``` +{% endtab %} +{% endtabs %} Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index f160a5fdb..a1312416e 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -1,8 +1,12 @@ # Deactivate a Phone +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/deactivate ⇒ void ``` +{% endtab %} +{% endtabs %} Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 8d1166c18..d609d8c6c 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -1,8 +1,12 @@ # Get Phone +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/get ⇒ { phone } ``` +{% endtab %} +{% endtabs %} Returns a single phone entry matching the provided `device_id`. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index e85c3aba1..f7bcc6972 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -1,8 +1,12 @@ # List Phones +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/list ⇒ { phones: [phone, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index c6ef24d60..1686ede5d 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -1,8 +1,12 @@ # Create a Sandbox Phone +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` +{% endtab %} +{% endtabs %} Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 4a76e9bf7..a387eca74 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -1,8 +1,12 @@ # Activate a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 834cec24c..b8148a391 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -1,8 +1,12 @@ # Set to Cool Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/cool ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 0d93d5898..4f20ffbae 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -1,8 +1,12 @@ # Create a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/create_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 13dd99c46..dd5f15a73 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -1,8 +1,12 @@ # Delete a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/delete_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 0ee93ebd8..3995967e2 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -1,8 +1,12 @@ # Set to Heat Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/heat ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index acf0ee0fa..3f8f59ded 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -1,8 +1,12 @@ # Set to Heat-Cool (Auto) Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/heat_cool ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index ed07f77cc..e96d7a983 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1,8 +1,12 @@ # List Thermostats +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/list ⇒ { devices: [device, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 07e778ab1..83049a22c 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -1,8 +1,12 @@ # Set to Off Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/off ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 2749a96e8..2ae7c7eba 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -1,8 +1,12 @@ # Create a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` +{% endtab %} +{% endtabs %} Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 6b64d3d23..24913deb7 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -1,8 +1,12 @@ # Delete a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 102f9e1ef..d447f1fb8 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -1,8 +1,12 @@ # Get a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` +{% endtab %} +{% endtabs %} Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index dddd3fafa..23648c329 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -1,8 +1,12 @@ # List Thermostat Schedules +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 2b7c2af5a..2f170b593 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -1,8 +1,12 @@ # Update a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/schedules/update ⇒ void ``` +{% endtab %} +{% endtabs %} Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 362676b36..e5c879c78 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -1,8 +1,12 @@ # Set the Fallback Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_fallback_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 5a88879c2..ba9666104 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -1,8 +1,12 @@ # Set the Fan Mode Setting +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 82dbc09dd..4433ae302 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -1,8 +1,12 @@ # Set the HVAC Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index b7b4d24ac..6ef3cc763 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -1,8 +1,12 @@ # Set a Temperature Threshold +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/set_temperature_threshold ⇒ void ``` +{% endtab %} +{% endtabs %} Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 11b27a62d..85c397611 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -1,8 +1,12 @@ # HVAC Mode Adjusted +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 66a10e442..27a3e90f1 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -1,8 +1,12 @@ # Temperature Reached +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/simulate/temperature_reached ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 3e56936f9..0e37698a0 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -1,8 +1,12 @@ # Update a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/update_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 52ed3a60d..4bfc51015 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -1,8 +1,12 @@ # Add an ACS User to a User Identity +{% tabs %} +{% tab title="Signature" %} ``` PUT /user_identities/add_acs_user ⇒ void ``` +{% endtab %} +{% endtabs %} Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 07eda4a0a..27be89a33 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -1,8 +1,12 @@ # Create a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/create ⇒ { user_identity } ``` +{% endtab %} +{% endtabs %} Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 2f56d236e..cffd2486b 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -1,8 +1,12 @@ # Delete a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index e914ebc3e..bf4463b81 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -1,8 +1,12 @@ # Delete an Enrollment Automation +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index ee922cf72..3b93f089e 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -1,8 +1,12 @@ # Get an Enrollment Automation +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` +{% endtab %} +{% endtabs %} Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 8ca8fb9d4..14042b574 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -1,8 +1,12 @@ # Launch an Enrollment Automation +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation } ``` +{% endtab %} +{% endtabs %} Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 7e8901f8f..0fbd5c84b 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -1,8 +1,12 @@ # List Enrollment Automations +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index e5af4532e..c84ae5e22 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -1,8 +1,12 @@ # Get a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/get ⇒ { user_identity } ``` +{% endtab %} +{% endtabs %} Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index c7fea2e76..3f158dcd7 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -1,8 +1,12 @@ # Grant a User Identity Access to a Device +{% tabs %} +{% tab title="Signature" %} ``` PUT /user_identities/grant_access_to_device ⇒ void ``` +{% endtab %} +{% endtabs %} Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 68bd99c01..d7b06f578 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -1,8 +1,12 @@ # List User Identities +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 2b9f6c65c..37a235e87 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1,8 +1,12 @@ # List Accessible Devices for a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index ed32673e6..8e93e5109 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -1,8 +1,12 @@ # List ACS Systems Associated with a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index fc84f52bc..49b3bccec 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -1,8 +1,12 @@ # List ACS Users Associated with a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 663270462..fb35b5b9b 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -1,8 +1,12 @@ # Remove an ACS User from a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/remove_acs_user ⇒ void ``` +{% endtab %} +{% endtabs %} Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 0d8590456..731f6f2a1 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -1,8 +1,12 @@ # Revoke Access to a Device from a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/revoke_access_to_device ⇒ void ``` +{% endtab %} +{% endtabs %} Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 742e986f3..2d9bc7c8c 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -1,8 +1,12 @@ # Update a User Identity +{% tabs %} +{% tab title="Signature" %} ``` PATCH /user_identities/update ⇒ void ``` +{% endtab %} +{% endtabs %} From 66206196d51ef7fdd92201c748adfbec1d9295ee Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 19:32:05 -0400 Subject: [PATCH 43/60] Update SUMMARY.md --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e0b72de26..2a1e054ba 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -139,7 +139,7 @@ * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) -* [Access Control Systems (ACS)](api/acs/README.md) +* [Access Control Systems](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) * [Get an ACS System](api/acs/systems/get.md) From 196d81d676e34b81a618b24412adf6215297568d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 19:36:51 -0400 Subject: [PATCH 44/60] Update paths.yaml --- src/data/paths.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 59ffc89a8..94caa45c4 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -1,6 +1,6 @@ --- /acs: - title: Access Control Systems (ACS) + title: Access Control Systems description: Systems for managing and monitoring access to physical spaces overview: | Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 49dec45fff451563693519c4cde861345c7c366e Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 23:37:50 +0000 Subject: [PATCH 45/60] ci: Generate docs --- docs/api/acs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 78c99bd4b..b6244626e 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems (ACS) +# Access Control Systems Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,7 +21,7 @@ To grant access using the Seam access control system API, use the following basi ## Resources -The Access Control Systems (ACS) namespace contains the following resources: +The Access Control Systems namespace contains the following resources: ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From e7a5612f50046017343bab65dd744d94cc5fb653 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 13:16:06 +0000 Subject: [PATCH 46/60] ci: Generate docs --- docs/api/access_codes/README.md | 280 -------------------------------- 1 file changed, 280 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 34a356bf0..7025eafbb 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -511,63 +511,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.changed` @@ -579,63 +563,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.scheduled_on_device` @@ -647,71 +615,53 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
code Format: String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.set_on_device` @@ -723,71 +673,53 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
code Format: String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.removed_from_device` @@ -799,63 +731,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.delay_in_setting_on_device` @@ -867,63 +783,47 @@ There was an unusually long delay in setting an [access code](https://docs.seam. access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.failed_to_set_on_device` @@ -935,63 +835,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.deleted` @@ -1003,71 +887,53 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
code Format: String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.delay_in_removing_from_device` @@ -1079,63 +945,47 @@ There was an unusually long delay in removing an [access code](https://docs.seam access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.failed_to_remove_from_device` @@ -1147,63 +997,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.modified_external_to_seam` @@ -1215,63 +1049,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.deleted_external_to_seam` @@ -1283,63 +1101,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.backup_access_code_pulled` @@ -1351,69 +1153,51 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
backup_access_code_id Format: String -
-
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.unmanaged.converted_to_managed` @@ -1425,63 +1209,47 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.unmanaged.failed_to_convert_to_managed` @@ -1493,63 +1261,47 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.unmanaged.created` @@ -1561,63 +1313,47 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- ### `access_code.unmanaged.removed` @@ -1629,62 +1365,46 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
connected_account_id Format: UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
created_at Format: Datetime Date and time at which the event was created. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
occurred_at Format: Datetime Date and time at which the event occurred. -
-
workspace_id Format: UUID ID of the [workspace](../../core-concepts/workspaces/README.md). -
- --- From d8a1e325dbddb00595ff82171a0e5bdb1db4056e Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:05:51 -0400 Subject: [PATCH 47/60] Update paths.yaml --- src/data/paths.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 94caa45c4..59ffc89a8 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -1,6 +1,6 @@ --- /acs: - title: Access Control Systems + title: Access Control Systems (ACS) description: Systems for managing and monitoring access to physical spaces overview: | Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 76214553b16dffbc0eaab0179a55919bfabb1cd4 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:06:29 -0400 Subject: [PATCH 48/60] Update SUMMARY.md --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 2a1e054ba..e0b72de26 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -139,7 +139,7 @@ * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) -* [Access Control Systems](api/acs/README.md) +* [Access Control Systems (ACS)](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) * [Get an ACS System](api/acs/systems/get.md) From ce6d871ce971c854f552c8a7ec67f544e0989d9f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 18:09:43 +0000 Subject: [PATCH 49/60] ci: Generate docs --- docs/api/acs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index b6244626e..78c99bd4b 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems +# Access Control Systems (ACS) Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,7 +21,7 @@ To grant access using the Seam access control system API, use the following basi ## Resources -The Access Control Systems namespace contains the following resources: +The Access Control Systems (ACS) namespace contains the following resources: ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From 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 50/60] Fix typo --- src/layouts/api-endpoint.hbs | 4 ++-- src/lib/layout/api-endpoint.ts | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 23df0a346..f1b91f3cd 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -46,11 +46,11 @@ None {{> api-resource headingOffset=true}} {{/with}} -{{#if addtionalCodeSamples.length}} +{{#if additionalCodeSamples.length}} ## Additional Code Samples -{{#each addtionalCodeSamples}} +{{#each additionalCodeSamples}} {{> code-sample }} {{/each}} {{/if}} diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 36f82ac58..53de2921a 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -45,7 +45,7 @@ export interface ApiEndpointLayoutContext { actionAttempt?: ApiRouteResource } primaryCodeSample: CodeSampleContext | null - addtionalCodeSamples: CodeSampleContext[] + additionalCodeSamples: CodeSampleContext[] } interface CodeSampleContext { @@ -153,10 +153,10 @@ export function setEndpointLayoutContext( } } - const [primaryCodeSample, ...addtionalCodeSamples] = endpoint.codeSamples + const [primaryCodeSample, ...additionalCodeSamples] = endpoint.codeSamples file.primaryCodeSample = primaryCodeSample == null ? null : mapCodeSample(primaryCodeSample) - file.addtionalCodeSamples = addtionalCodeSamples.map(mapCodeSample) + file.additionalCodeSamples = additionalCodeSamples.map(mapCodeSample) } const mapCodeSample = (sample: CodeSample): CodeSampleContext => { From f43544059fcba9f66a9a8a09d0a69f4f2d757233 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:21:49 +0200 Subject: [PATCH 51/60] Add item format for array request params --- package-lock.json | 8 ++++---- package.json | 2 +- src/layouts/api-endpoint.hbs | 7 +++++++ src/layouts/partials/enum-values.hbs | 4 ++++ src/lib/layout/api-endpoint.ts | 9 +++++++++ 5 files changed, 25 insertions(+), 5 deletions(-) create mode 100644 src/layouts/partials/enum-values.hbs diff --git a/package-lock.json b/package-lock.json index 3ec2d7e13..7e5295b0e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,7 +13,7 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.37.1", + "@seamapi/blueprint": "^0.38.0", "@seamapi/types": "1.369.2", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -767,9 +767,9 @@ "peer": true }, "node_modules/@seamapi/blueprint": { - "version": "0.37.1", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.37.1.tgz", - "integrity": "sha512-OSJqrWL3KzCWgNiw4gw+5Cp1PHCb+BudWFa6+7bd+RQDL/fzwC6RvlcFAp4Md3Fw2SYfxrH7uEwVTEhJYrPIjQ==", + "version": "0.38.0", + "resolved": "https://npm.pkg.github.com/download/@seamapi/blueprint/0.38.0/31038259651b23b963051292381bb4fef8ab07cb", + "integrity": "sha512-NlmzFZgoWORyKIsrKpTUdwOwHLzyV421VsYbDEPD/s/2c4wZoQdunjLHc1qgdfqvb5602+XVFldyi6bs0ssRNA==", "license": "MIT", "dependencies": { "change-case": "^5.4.4", diff --git a/package.json b/package.json index 452147c2c..400f44404 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.37.1", + "@seamapi/blueprint": "^0.38.0", "@seamapi/types": "1.369.2", "change-case": "^5.4.4", "command-exists": "^1.2.9", diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index f1b91f3cd..3d71edc58 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -28,7 +28,14 @@ ### `{{this.name}}` Type: `{{this.jsonType}}` +{{#if this.itemFormat}} +Item format: `{{this.itemFormat}}` +{{/if}} Required: {{#if this.required}}Yes{{else}}No{{/if}} +{{#if this.itemEnumValues}} + +{{> enum-values enumValues=this.itemEnumValues}} +{{/if}} {{this.description}} diff --git a/src/layouts/partials/enum-values.hbs b/src/layouts/partials/enum-values.hbs new file mode 100644 index 000000000..b5df183d8 --- /dev/null +++ b/src/layouts/partials/enum-values.hbs @@ -0,0 +1,4 @@ +Possible enum values: +{{#each enumValues}} +- `{{this}}` +{{/each}} \ No newline at end of file diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 53de2921a..defdc40f1 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -2,6 +2,7 @@ import type { ActionAttempt, CodeSampleSdk, Endpoint, + EnumProperty, SeamAuthMethod, SeamWorkspaceScope, } from '@seamapi/blueprint' @@ -34,6 +35,8 @@ export interface ApiEndpointLayoutContext { required: boolean description: string jsonType: string + itemFormat?: string + itemEnumValues?: EnumProperty['values'] }> } response: { @@ -106,6 +109,12 @@ export function setEndpointLayoutContext( required: param.isRequired, description: param.description, jsonType: param.jsonType, + ...(param.jsonType === 'array' && { + itemFormat: param.itemFormat, + ...(param.itemFormat === 'enum' && { + itemEnumValues: param.itemEnumValues, + }), + }), })) .sort((a, b) => { if (a.required && !b.required) return -1 From db30d747ee867021275f8b834fe2f9dac07ca8fc Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:24:38 +0200 Subject: [PATCH 52/60] Fix blueprint registry url --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 7e5295b0e..0468b2834 100644 --- a/package-lock.json +++ b/package-lock.json @@ -768,7 +768,7 @@ }, "node_modules/@seamapi/blueprint": { "version": "0.38.0", - "resolved": "https://npm.pkg.github.com/download/@seamapi/blueprint/0.38.0/31038259651b23b963051292381bb4fef8ab07cb", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.38.0.tgz", "integrity": "sha512-NlmzFZgoWORyKIsrKpTUdwOwHLzyV421VsYbDEPD/s/2c4wZoQdunjLHc1qgdfqvb5602+XVFldyi6bs0ssRNA==", "license": "MIT", "dependencies": { From 140dfa459f7f90989d8d87958765d2e3688035b1 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:25:39 +0000 Subject: [PATCH 53/60] ci: Generate docs --- docs/api/_report.md | 27 +++++++++++++ docs/api/acs/credentials/create.md | 1 + docs/api/acs/encoders/list.md | 2 + .../entrances/list_credentials_with_access.md | 4 ++ docs/api/acs/users/create.md | 1 + docs/api/thermostats/list.md | 40 +++++++++++++++++++ 6 files changed, 75 insertions(+) diff --git a/docs/api/_report.md b/docs/api/_report.md index 75faae138..dc98e3a63 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -194,12 +194,14 @@ Items that are intentionally undocumented are not included in this section. - `client_session` - `connect_webview` - `connected_account` +- `device` - `device_provider` - `event` - `network` - `noise_threshold` - `unmanaged_access_code` - `unmanaged_acs_access_group` +- `unmanaged_device` - `webhook` - `workspace` @@ -271,6 +273,18 @@ Items that are intentionally undocumented are not included in this section. - `connected_account.errors` - `connected_account.user_identifier` - `connected_account.warnings` +- `device.can_hvac_cool` +- `device.can_hvac_heat` +- `device.can_hvac_heat_cool` +- `device.can_program_offline_access_codes` +- `device.can_program_online_access_codes` +- `device.can_remotely_lock` +- `device.can_remotely_unlock` +- `device.can_simulate_connection` +- `device.can_simulate_disconnection` +- `device.can_simulate_removal` +- `device.can_turn_off_hvac` +- `device.custom_metadata` - `device_provider.can_hvac_cool` - `device_provider.can_hvac_heat` - `device_provider.can_hvac_heat_cool` @@ -312,6 +326,19 @@ Items that are intentionally undocumented are not included in this section. - `unmanaged_acs_user.is_managed` - `unmanaged_acs_user.latest_desired_state_synced_with_provider_at` - `unmanaged_acs_user.pending_modifications` +- `unmanaged_device.can_hvac_cool` +- `unmanaged_device.can_hvac_heat` +- `unmanaged_device.can_hvac_heat_cool` +- `unmanaged_device.can_program_offline_access_codes` +- `unmanaged_device.can_program_online_access_codes` +- `unmanaged_device.can_remotely_lock` +- `unmanaged_device.can_remotely_unlock` +- `unmanaged_device.can_simulate_connection` +- `unmanaged_device.can_simulate_disconnection` +- `unmanaged_device.can_simulate_removal` +- `unmanaged_device.can_turn_off_hvac` +- `unmanaged_device.is_managed` +- `unmanaged_device.properties` - `user_identity.display_name` - `user_identity.full_name` - `webhook.event_types` diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index af1e25bfe..c2666512d 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -236,6 +236,7 @@ ID of the ACS user to whom the new credential belongs. ### `allowed_acs_entrance_ids` Type: `array` +Item format: `id` Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5705eee18..b827a37e6 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -17,6 +17,7 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki ### `acs_encoder_ids` Type: `array` +Item format: `id` Required: No IDs of the `acs_encoder`s that you want to retrieve. @@ -35,6 +36,7 @@ ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. ### `acs_system_ids` Type: `array` +Item format: `id` Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6cd85a7bf..645e2a735 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -252,8 +252,12 @@ Required: Yes ### `include_if` Type: `array` +Item format: `enum` Required: No +Possible enum values: +- `[object Object]` + *** diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 6137a24e7..377ce55e9 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -218,6 +218,7 @@ Required: No ### `acs_access_group_ids` Type: `array` +Item format: `id` Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f0adedbe6..64581fa2f 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -249,6 +249,7 @@ ID of the connected account by which to filter. ### `connected_account_ids` Type: `array` +Item format: `id` Required: No Array of IDs of the connected accounts by which to filter devices. @@ -276,6 +277,7 @@ Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-met ### `device_ids` Type: `array` +Item format: `id` Required: No Array of device IDs by which to filter devices. @@ -294,8 +296,46 @@ Device type by which to filter devices. ### `device_types` Type: `array` +Item format: `enum` Required: No +Possible enum values: +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` + Array of device types by which to filter devices. *** From 192818d1fcc21792866bb5f36aaa6852914a9f7d Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:32:48 +0200 Subject: [PATCH 54/60] Normalize item format, fix enum values --- src/lib/layout/api-endpoint.ts | 8 ++++---- src/lib/layout/api-route.ts | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index defdc40f1..523a82c5c 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -2,7 +2,6 @@ import type { ActionAttempt, CodeSampleSdk, Endpoint, - EnumProperty, SeamAuthMethod, SeamWorkspaceScope, } from '@seamapi/blueprint' @@ -11,6 +10,7 @@ import type { CodeSample } from 'node_modules/@seamapi/blueprint/dist/index.cjs' import { type ApiRouteResource, mapBlueprintPropertyToRouteProperty, + normalizePropertyFormatForDocs, } from './api-route.js' const supportedSdks: CodeSampleSdk[] = [ @@ -36,7 +36,7 @@ export interface ApiEndpointLayoutContext { description: string jsonType: string itemFormat?: string - itemEnumValues?: EnumProperty['values'] + itemEnumValues?: string[] }> } response: { @@ -110,9 +110,9 @@ export function setEndpointLayoutContext( description: param.description, jsonType: param.jsonType, ...(param.jsonType === 'array' && { - itemFormat: param.itemFormat, + itemFormat: normalizePropertyFormatForDocs(param.itemFormat), ...(param.itemFormat === 'enum' && { - itemEnumValues: param.itemEnumValues, + itemEnumValues: param.itemEnumValues.map(({ name }) => name), }), }), })) diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts index d3249a699..71c0b75ca 100644 --- a/src/lib/layout/api-route.ts +++ b/src/lib/layout/api-route.ts @@ -250,7 +250,7 @@ export const mapBlueprintPropertyToRouteProperty = ( type PropertyFormat = Property['format'] | ListProperty['itemFormat'] type ListProperty = Extract -const normalizePropertyFormatForDocs = (format: PropertyFormat): string => { +export const normalizePropertyFormatForDocs = (format: PropertyFormat): string => { const formatMap: Partial> = { id: 'UUID', discriminated_object: 'Object', From ba841b552e513e294d5404124bbcf1f9d4022d87 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:33:54 +0000 Subject: [PATCH 55/60] ci: Format code --- src/lib/layout/api-route.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts index 71c0b75ca..799e80a5a 100644 --- a/src/lib/layout/api-route.ts +++ b/src/lib/layout/api-route.ts @@ -250,7 +250,9 @@ export const mapBlueprintPropertyToRouteProperty = ( type PropertyFormat = Property['format'] | ListProperty['itemFormat'] type ListProperty = Extract -export const normalizePropertyFormatForDocs = (format: PropertyFormat): string => { +export const normalizePropertyFormatForDocs = ( + format: PropertyFormat, +): string => { const formatMap: Partial> = { id: 'UUID', discriminated_object: 'Object', From 8b135cfa3eb6b2739164954471409de85c67c2d6 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:34:58 +0000 Subject: [PATCH 56/60] ci: Generate docs --- docs/api/acs/credentials/create.md | 2 +- docs/api/acs/encoders/list.md | 4 +- .../entrances/list_credentials_with_access.md | 4 +- docs/api/acs/users/create.md | 2 +- docs/api/thermostats/list.md | 76 +++++++++---------- 5 files changed, 44 insertions(+), 44 deletions(-) diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index c2666512d..067bc8d2c 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -236,7 +236,7 @@ ID of the ACS user to whom the new credential belongs. ### `allowed_acs_entrance_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index b827a37e6..fa027033b 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -17,7 +17,7 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki ### `acs_encoder_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No IDs of the `acs_encoder`s that you want to retrieve. @@ -36,7 +36,7 @@ ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. ### `acs_system_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 645e2a735..7e8107d4e 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -252,11 +252,11 @@ Required: Yes ### `include_if` Type: `array` -Item format: `enum` +Item format: `Enum` Required: No Possible enum values: -- `[object Object]` +- `visionline_metadata.is_valid` diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 377ce55e9..2b7d017b4 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -218,7 +218,7 @@ Required: No ### `acs_access_group_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 64581fa2f..0c7a772f2 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -249,7 +249,7 @@ ID of the connected account by which to filter. ### `connected_account_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Array of IDs of the connected accounts by which to filter devices. @@ -277,7 +277,7 @@ Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-met ### `device_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Array of device IDs by which to filter devices. @@ -296,45 +296,45 @@ Device type by which to filter devices. ### `device_types` Type: `array` -Item format: `enum` +Item format: `Enum` Required: No Possible enum values: -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` +- `akuvox_lock` +- `august_lock` +- `brivo_access_point` +- `butterflymx_panel` +- `avigilon_alta_entry` +- `doorking_lock` +- `genie_door` +- `igloo_lock` +- `linear_lock` +- `lockly_lock` +- `kwikset_lock` +- `nuki_lock` +- `salto_lock` +- `schlage_lock` +- `seam_relay` +- `smartthings_lock` +- `wyze_lock` +- `yale_lock` +- `two_n_intercom` +- `controlbyweb_device` +- `ttlock_lock` +- `igloohome_lock` +- `hubitat_lock` +- `four_suites_door` +- `dormakaba_oracode_door` +- `tedee_lock` +- `akiles_lock` +- `noiseaware_activity_zone` +- `minut_sensor` +- `ecobee_thermostat` +- `nest_thermostat` +- `honeywell_resideo_thermostat` +- `tado_thermostat` +- `ios_phone` +- `android_phone` Array of device types by which to filter devices. From 7a04ff4df738783632cd6176933c295ef6d2e40f Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:42:28 +0200 Subject: [PATCH 57/60] Use enum partial --- src/layouts/partials/api-resource.hbs | 5 +---- src/layouts/partials/enum-values.hbs | 4 ++-- src/layouts/partials/property-content.hbs | 5 +---- src/layouts/partials/property-nested-internal.hbs | 5 +---- 4 files changed, 5 insertions(+), 14 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 6f432d754..b0095f73a 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -30,10 +30,7 @@ Item format: `{{listItemFormat}}` {{/if}} {{#if enumValues}} -Possible enum values: -{{#each enumValues}} -- `{{this}}` -{{/each}} +{{> enum-values}} {{/if}} {{#unless (eq objectProperties undefined)}} {{#if (eq objectProperties.length 0)}} diff --git a/src/layouts/partials/enum-values.hbs b/src/layouts/partials/enum-values.hbs index b5df183d8..b055f3682 100644 --- a/src/layouts/partials/enum-values.hbs +++ b/src/layouts/partials/enum-values.hbs @@ -1,4 +1,4 @@ -Possible enum values: +{{#if indentationOffset}}{{indentationOffset}}{{/if}}Possible enum values: {{#each enumValues}} -- `{{this}}` +{{#if ../indentationOffset}}{{../indentationOffset}}{{/if}}- `{{this}}` {{/each}} \ No newline at end of file diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs index 07866a381..d5b650ff5 100644 --- a/src/layouts/partials/property-content.hbs +++ b/src/layouts/partials/property-content.hbs @@ -8,10 +8,7 @@ {{/if}} {{#if enumValues}} -Possible enum values: -{{#each enumValues}} -- `{{this}}` -{{/each}} +{{> enum-values}} {{/if}} {{#if listProperties}} {{#each listProperties}} diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs index 4b59f0076..16d7c4c42 100644 --- a/src/layouts/partials/property-nested-internal.hbs +++ b/src/layouts/partials/property-nested-internal.hbs @@ -8,8 +8,5 @@ {{/if}} {{#if enumValues}} - Possible enum values: -{{#each enumValues}} - - `{{this}}` -{{/each}} +{{> enum-values indentationOffset=" "}} {{/if}} \ No newline at end of file From 03f1377a4f7c983bf0bcfb9f99ece356fe72cf73 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:46:04 +0200 Subject: [PATCH 58/60] Put desctiption before possible enum values --- src/layouts/api-endpoint.hbs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 3d71edc58..70d7556bc 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -32,13 +32,15 @@ Type: `{{this.jsonType}}` Item format: `{{this.itemFormat}}` {{/if}} Required: {{#if this.required}}Yes{{else}}No{{/if}} +{{#if this.description}} + +{{this.description}} +{{/if}} {{#if this.itemEnumValues}} {{> enum-values enumValues=this.itemEnumValues}} {{/if}} -{{this.description}} - *** {{/each}} From 581af96cc3db3ba838b2f075f3dbeefa74e8df30 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:47:12 +0000 Subject: [PATCH 59/60] ci: Generate docs --- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 ---- docs/api/acs/entrances/get.md | 2 -- docs/api/acs/entrances/grant_access.md | 4 ---- docs/api/acs/entrances/list.md | 4 ---- docs/api/acs/entrances/list_credentials_with_access.md | 4 ---- docs/api/acs/users/create.md | 2 -- docs/api/acs/users/list.md | 2 -- docs/api/acs/users/update.md | 4 ---- docs/api/thermostats/list.md | 4 ++-- docs/api/thermostats/set_fan_mode.md | 4 ---- docs/api/thermostats/set_hvac_mode.md | 2 -- docs/api/user_identities/get.md | 2 -- docs/api/user_identities/list.md | 2 -- docs/api/user_identities/update.md | 2 -- 14 files changed, 2 insertions(+), 40 deletions(-) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8a3333506..4946e8824 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -28,8 +28,6 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next Type: `string` Required: No - - *** ### `error_code` @@ -37,8 +35,6 @@ Required: No Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index b4bbbbdf4..9380e50c6 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -148,8 +148,6 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance Type: `string` Required: Yes - - *** ## Return Type diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8ea04aa67..5847cfc2f 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -19,8 +19,6 @@ POST /acs/entrances/grant_access ⇒ void Type: `string` Required: Yes - - *** ### `acs_user_id` @@ -28,8 +26,6 @@ Required: Yes Type: `string` Required: Yes - - *** ## Return Type diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index acf540d23..083fb93bd 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -148,8 +148,6 @@ func main() { Type: `string` Required: No - - *** ### `acs_system_id` @@ -157,8 +155,6 @@ Required: No Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 7e8107d4e..bfa174069 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -245,8 +245,6 @@ func main() { Type: `string` Required: Yes - - *** ### `include_if` @@ -258,8 +256,6 @@ Required: No Possible enum values: - `visionline_metadata.is_valid` - - *** ## Return Type diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 2b7d017b4..0459ac6c4 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -230,8 +230,6 @@ Array of `access_group_id`s to indicate the access groups to which to add the ne Type: `string` Required: No - - *** ### `email_address` diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index b23c5a49e..d0465e7d1 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -167,8 +167,6 @@ ID of the `acs_system` for which you want to retrieve all `acs_user`s. Type: `string` Required: No - - *** ### `limit` diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index dccb7c8af..c4a2ef58d 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -149,8 +149,6 @@ Required: No Type: `string` Required: No - - *** ### `email_address` @@ -176,8 +174,6 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access Type: `string` Required: No - - *** ### `phone_number` diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 0c7a772f2..abcd7414e 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -299,6 +299,8 @@ Type: `array` Item format: `Enum` Required: No +Array of device types by which to filter devices. + Possible enum values: - `akuvox_lock` - `august_lock` @@ -336,8 +338,6 @@ Possible enum values: - `ios_phone` - `android_phone` -Array of device types by which to filter devices. - *** ### `limit` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 5ceb92167..8e4f44cc3 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -152,8 +152,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu Type: `string` Required: Yes - - *** ### `fan_mode` @@ -161,8 +159,6 @@ Required: Yes Type: `string` Required: No - - *** ### `fan_mode_setting` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index f1e05acfd..9dc658f9c 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -172,8 +172,6 @@ ID of the desired thermostat device. Type: `string` Required: Yes - - *** ### `cooling_set_point_celsius` diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a76dbf454..9530bc553 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -177,8 +177,6 @@ ID of the desired user identity. Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7044c7aaa..1cd65237f 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -168,8 +168,6 @@ func main() { Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d5deb5c99..fb4085307 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -37,8 +37,6 @@ Unique email address for the user identity. Type: `string` Required: No - - *** ### `phone_number` From 2f17cc5eaebc0a7577115b93896c1df231b0b33a Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 21:21:57 +0000 Subject: [PATCH 60/60] ci: Generate docs --- .../acs/encoders/simulate/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 +++-- docs/api/acs/entrances/list_credentials_with_access.md | 5 +++-- 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 | 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, 27 insertions(+), 20 deletions(-) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index e5aa04549..c1029de34 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -34,14 +34,15 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next Type: `string` Required: No -*** +--- ### `error_code` Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index f9fb4a3bf..dea604ca0 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -154,7 +154,8 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance Type: `string` Required: Yes -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 6366129cc..cf513acb3 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -25,14 +25,15 @@ POST /acs/entrances/grant_access ⇒ void Type: `string` Required: Yes -*** +--- ### `acs_user_id` Type: `string` Required: Yes -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 306e003c1..a95de75be 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -154,14 +154,15 @@ func main() { Type: `string` Required: No -*** +--- ### `acs_system_id` Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 53776fedf..ea1783d67 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -251,7 +251,7 @@ func main() { Type: `string` Required: Yes -*** +--- ### `include_if` @@ -262,7 +262,8 @@ Required: No Possible enum values: - `visionline_metadata.is_valid` -*** +--- + ## Return Type diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 01fc943bb..e3d10f32a 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -231,7 +231,7 @@ 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 9e7b00e6c..4685f4fbb 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -173,7 +173,7 @@ ID of the `acs_system` for which you want to retrieve all `acs_user`s. Type: `string` Required: No -*** +--- ### `limit` diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 5b9bbc1d9..d4e5ed6e6 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -155,7 +155,7 @@ Required: No Type: `string` Required: No -*** +--- ### `email_address` @@ -180,7 +180,7 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access Type: `string` Required: No -*** +--- ### `phone_number` diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 8605939d6..60c7c5167 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -344,7 +344,7 @@ Possible enum values: - `ios_phone` - `android_phone` -*** +--- ### `limit` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index e83c23b27..d4104ee29 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 ca38f819c..ed1438bde 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -178,7 +178,7 @@ ID of the desired thermostat device. Type: `string` Required: Yes -*** +--- ### `cooling_set_point_celsius` diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 8c1fafb0b..14c494f13 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -183,7 +183,8 @@ ID of the desired user identity. Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index d272a3a23..6ebafb252 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -174,7 +174,8 @@ func main() { Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 5b1ce667d..afae2ac5b 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -43,7 +43,7 @@ Unique email address for the user identity. Type: `string` Required: No -*** +--- ### `phone_number`