From 7e2064741930ba25ef7b9e2d71457c75c65a3511 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Tue, 10 Dec 2024 13:56:37 +0100 Subject: [PATCH 1/3] Use prettier ruby plugin to format ruby samples --- .github/workflows/generate.yml | 4 ++-- package-lock.json | 9 +++++++++ package.json | 1 + src/lib.d.ts | 5 +++++ src/lib/format-code.ts | 16 +++++++--------- 5 files changed, 24 insertions(+), 11 deletions(-) diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index d295629f..6585eae5 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -48,8 +48,8 @@ jobs: uses: actions/setup-go@v5 with: go-version: '^1.23.2' - - name: Install standardrb - run: gem install standard -v 1.31.0 + - name: Install syntax_tree + run: gem install syntax_tree - name: Normalize package-lock.json run: npm install - name: Generate docs diff --git a/package-lock.json b/package-lock.json index ffb3ac62..7f4e3786 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,7 @@ "@metalsmith/layouts": "^2.7.0", "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", + "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.29.0", "@seamapi/types": "1.309.0", "change-case": "^5.4.4", @@ -686,6 +687,14 @@ "prettier": "^3.0.0" } }, + "node_modules/@prettier/plugin-ruby": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@prettier/plugin-ruby/-/plugin-ruby-4.0.4.tgz", + "integrity": "sha512-lCpvfS/dQU5WrwN3AQ5vR8qrvj2h5gE41X08NNzAAXvHdM4zwwGRcP2sHSxfu6n6No+ljWCVx95NvJPFTTjCTg==", + "peerDependencies": { + "prettier": "^3.0.0" + } + }, "node_modules/@rtsao/scc": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@rtsao/scc/-/scc-1.1.0.tgz", diff --git a/package.json b/package.json index d237aa92..5d8c4846 100644 --- a/package.json +++ b/package.json @@ -32,6 +32,7 @@ "@metalsmith/layouts": "^2.7.0", "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", + "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.29.0", "@seamapi/types": "1.309.0", "change-case": "^5.4.4", diff --git a/src/lib.d.ts b/src/lib.d.ts index 4751c32d..f7ed087e 100644 --- a/src/lib.d.ts +++ b/src/lib.d.ts @@ -1 +1,6 @@ declare module '@prettier/plugin-php/standalone' +declare module '@prettier/plugin-ruby' { + import type { Plugin } from 'prettier' + const plugin: Plugin + export default plugin +} diff --git a/src/lib/format-code.ts b/src/lib/format-code.ts index 7e24db94..4a0d86d6 100644 --- a/src/lib/format-code.ts +++ b/src/lib/format-code.ts @@ -1,4 +1,5 @@ import * as prettierPluginPhp from '@prettier/plugin-php/standalone' +import * as prettierPluginRuby from '@prettier/plugin-ruby' import type { CodeSampleSyntax } from '@seamapi/blueprint' import commandExists from 'command-exists' import { execa } from 'execa' @@ -53,15 +54,12 @@ const formatPython = async (content: string): Promise => { } const formatRuby = async (content: string): Promise => { - try { - await commandExists('ruff') - } catch { - // eslint-disable-next-line no-console - console.warn('Skipping ruby formatting: standardrb is not installed') - return content - } - const result = await execa({ input: content })`standardrb --stdin --fix -` - return result.stdout.split('\n').slice(1).join('\n') + return await prettier(content, { + parser: 'ruby', + plugins: [prettierPluginRuby.default], + printWidth: 100, + trailingComma: 'all', + }) } const formatGo = async (content: string): Promise => { From f566eb9aacfe721faace91e433719ef7f08db3bd Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 10 Dec 2024 12:57:28 +0000 Subject: [PATCH 2/3] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 5 +- docs/api/acs/access_groups/get.md | 13 +++- docs/api/acs/access_groups/list.md | 20 +++++- .../list_accessible_entrances.md | 15 ++++- docs/api/acs/access_groups/list_users.md | 23 ++++++- docs/api/acs/access_groups/remove_user.md | 5 +- docs/api/acs/credentials/assign.md | 5 +- docs/api/acs/credentials/create.md | 25 +++++++- docs/api/acs/credentials/get.md | 12 +++- docs/api/acs/credentials/list.md | 21 ++++++- .../credentials/list_accessible_entrances.md | 20 +++++- docs/api/acs/credentials/unassign.md | 5 +- docs/api/acs/entrances/get.md | 7 ++- docs/api/acs/entrances/list.md | 11 +++- .../entrances/list_credentials_with_access.md | 29 ++++++++- docs/api/acs/systems/get.md | 2 +- docs/api/acs/systems/list.md | 2 +- ...mpatible_credential_manager_acs_systems.md | 6 +- docs/api/acs/users/add_to_access_group.md | 5 +- docs/api/acs/users/create.md | 12 +++- docs/api/acs/users/get.md | 12 +++- docs/api/acs/users/list.md | 14 ++++- .../api/acs/users/remove_from_access_group.md | 5 +- docs/api/acs/users/update.md | 5 +- .../thermostats/activate_climate_preset.md | 11 +++- docs/api/thermostats/cool.md | 11 +++- docs/api/thermostats/create_climate_preset.md | 11 +++- docs/api/thermostats/delete_climate_preset.md | 5 +- docs/api/thermostats/heat.md | 11 +++- docs/api/thermostats/heat_cool.md | 12 +++- docs/api/thermostats/list.md | 27 +++++++- docs/api/thermostats/off.md | 6 +- docs/api/thermostats/schedules/create.md | 19 +++++- docs/api/thermostats/schedules/get.md | 10 ++- docs/api/thermostats/schedules/list.md | 22 ++++++- docs/api/thermostats/schedules/update.md | 5 +- .../set_fallback_climate_preset.md | 5 +- docs/api/thermostats/set_fan_mode.md | 11 +++- .../thermostats/set_temperature_threshold.md | 6 +- docs/api/thermostats/update_climate_preset.md | 7 ++- docs/api/user_identities/add_acs_user.md | 5 +- docs/api/user_identities/create.md | 18 +++++- .../enrollment_automations/delete.md | 4 +- .../enrollment_automations/get.md | 14 ++++- .../enrollment_automations/launch.md | 17 ++++- .../enrollment_automations/list.md | 16 ++++- docs/api/user_identities/get.md | 11 +++- .../user_identities/grant_access_to_device.md | 5 +- docs/api/user_identities/list.md | 15 ++++- .../list_accessible_devices.md | 62 ++++++++++++++++++- docs/api/user_identities/list_acs_systems.md | 14 ++++- docs/api/user_identities/list_acs_users.md | 16 ++++- docs/api/user_identities/remove_acs_user.md | 5 +- .../revoke_access_to_device.md | 5 +- .../user_identities/update-a-user-identity.md | 2 - 55 files changed, 588 insertions(+), 79 deletions(-) delete mode 100644 docs/api/user_identities/update-a-user-identity.md diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 3b5fb859..2464ee51 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -45,7 +45,10 @@ None #### 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") +seam.acs.access_groups.add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) ``` #### Response diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index a58729b6..b1bf2e7f 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -69,7 +69,18 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 #### 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"} +{ + "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 %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 3150c06f..6991292d 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -71,13 +71,29 @@ seam.acs.access_groups.list( #### Request ```ruby -seam.acs.access_groups.list(acs_system_id: "11111111-1111-1111-1111-111111111111", acs_user_id: "33333333-3333-3333-3333-333333333333") +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"}] +[ + { + "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 %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index c8aaf092..0f4d3523 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -61,13 +61,24 @@ seam.acs.access_groups.list_accessible_entrances( #### Request ```ruby -seam.acs.access_groups.list_accessible_entrances(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +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"}] +[ + { + "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 %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 845e953c..fa10d964 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -91,7 +91,28 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- #### 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"}] +[ + { + "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 %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index c129d95b..9c1e0613 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -45,7 +45,10 @@ None #### 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") +seam.acs.access_groups.remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) ``` #### Response diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 12be57ff..59a9b7af 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.acs.credentials.assign(acs_user_id: "33333333-3333-3333-3333-333333333333", acs_credential_id: "66666666-6666-6666-6666-666666666666") +seam.acs.credentials.assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) ``` #### Response diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index d6201b81..80efe954 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -81,13 +81,34 @@ AcsCredential( #### Request ```ruby -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") +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} +{ + "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 %} diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index cb8d4f05..be320700 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -67,7 +67,17 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 #### 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} +{ + "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 %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index c1bd9366..695ed417 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -73,13 +73,30 @@ seam.acs.credentials.list( #### 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) +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}] +[ + { + "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 %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 49c71c67..500d2a65 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -81,13 +81,29 @@ seam.acs.credentials.list_accessible_entrances( #### Request ```ruby -seam.acs.credentials.list_accessible_entrances(acs_credential_id: "66666666-6666-6666-6666-666666666666") +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"}] +[ + { + "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 %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index dad6ffdc..d5385d26 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.acs.credentials.unassign(acs_user_id: "33333333-3333-3333-3333-333333333333", acs_credential_id: "66666666-6666-6666-6666-666666666666") +seam.acs.credentials.unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) ``` #### Response diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 076a05fe..be1baf8b 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -57,7 +57,12 @@ 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"} +{ + "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 %} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index bc596aa2..5c9aea5d 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -53,13 +53,20 @@ seam.acs.entrances.list() #### Request ```ruby -seam.acs.entrances.list +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"}] +[ + { + "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 %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index f865f401..d5a5bbb6 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -89,13 +89,38 @@ seam.acs.entrances.list_credentials_with_access( #### Request ```ruby -seam.acs.entrances.list_credentials_with_access(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") +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"}] +[ + { + "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 %} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 1284141c..7c280a53 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -49,7 +49,7 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") #### Response ```ruby -[{"acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}] +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] ``` {% endtab %} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 1adc64d0..2a25204a 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -51,7 +51,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 #### Response ```ruby -[{"acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}] +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] ``` {% endtab %} 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 3b11cce3..e32120af 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 @@ -47,13 +47,15 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( #### Request ```ruby -seam.acs.systems.list_compatible_credential_manager_acs_systems(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +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"}] +[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] ``` {% endtab %} diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index e1f42fe6..db448df2 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -45,7 +45,10 @@ None #### 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") +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 diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index f456659c..ce39f41e 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -67,7 +67,17 @@ seam.acs.users.create(acs_system_id: "123e4567-e89b-12d3-a456-426614174000") #### Response ```ruby -{"acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", "acs_access_group_ids" => ["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"} +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_access_group_ids" => ["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 %} diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 82ec1d4b..69b9f920 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -67,7 +67,17 @@ 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", "acs_access_group_ids" => ["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"} +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_access_group_ids" => ["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 %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 5745424c..4cd38b37 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -59,13 +59,23 @@ AcsUser( #### Request ```ruby -seam.acs.users.list +seam.acs.users.list() ``` #### Response ```ruby -{"acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", "acs_access_group_ids" => ["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"} +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_access_group_ids" => ["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 %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index b2aa217e..97f096e2 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -45,7 +45,10 @@ None #### 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") +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 diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 0b275a2c..080324ef 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -44,7 +44,10 @@ None #### Request ```ruby -seam.acs.users.update(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number: 12222222222) +seam.acs.users.update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: 12_222_222_222, +) ``` #### Response diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 0d02ee6a..890a101e 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -52,13 +52,20 @@ ActionAttempt( #### Request ```ruby -seam.thermostats.activate_climate_preset(device_id: "123e4567-e89b-12d3-a456-426614174000", climate_preset_key: "occupied") +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"} +{ + "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +} ``` {% endtab %} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 25faee94..9363d525 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -52,13 +52,20 @@ ActionAttempt( #### Request ```ruby -seam.thermostats.cool(device_id: "123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius: 25) +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"} +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +} ``` {% endtab %} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index d9178e91..08983d72 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -57,7 +57,16 @@ None #### 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) +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 diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 67213480..dcedf547 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -44,7 +44,10 @@ None #### Request ```ruby -seam.thermostats.delete_climate_preset(device_id: "123e4567-e89b-12d3-a456-426614174000", climate_preset_key: "occupied") +seam.thermostats.delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) ``` #### Response diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 5ca9e4bf..5f7d0276 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -52,13 +52,20 @@ ActionAttempt( #### Request ```ruby -seam.thermostats.heat(device_id: "123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius: 25) +seam.thermostats.heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 25, +) ``` #### Response ```ruby -{"action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", "status" => "pending", "action_type" => "SET_HEAT"} +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +} ``` {% endtab %} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 028429cc..771629a0 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -55,13 +55,21 @@ ActionAttempt( #### Request ```ruby -seam.thermostats.heat_cool(device_id: "123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius: 25, heating_set_point_celsius: 20) +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"} +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +} ``` {% endtab %} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 530b6c53..72a07838 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -85,13 +85,36 @@ seam.thermostats.list() #### Request ```ruby -seam.thermostats.list +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: ["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"}}] +[ + { + "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 %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 94639f67..06e43bfe 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -55,7 +55,11 @@ 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"} +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +} ``` {% endtab %} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index b4087b56..aa9a4391 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -69,13 +69,28 @@ ThermostatSchedule( #### 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) +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} +{ + "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 %} diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index bb767e85..d9c44015 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -65,7 +65,15 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- #### 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" => "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 %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index f1633b52..a6f2b6b9 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -85,8 +85,26 @@ 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}] +[ + { + "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 %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index eaaa72ab..70a1eb37 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.thermostats.schedules.update(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", ends_at: "2024-11-15T15:00:00Z") +seam.thermostats.schedules.update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +) ``` #### Response diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 79f7261b..d14363e4 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -44,7 +44,10 @@ None #### Request ```ruby -seam.thermostats.set_fallback_climate_preset(device_id: "123e4567-e89b-12d3-a456-426614174000", climate_preset_key: "eco") +seam.thermostats.set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +) ``` #### Response diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 2145cf30..3f44b9f2 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -52,13 +52,20 @@ ActionAttempt( #### Request ```ruby -seam.thermostats.set_fan_mode(device_id: "123e4567-e89b-12d3-a456-426614174000", fan_mode_setting: "auto") +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"} +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +} ``` {% endtab %} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index f1a016e6..d9a5f12a 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -47,7 +47,11 @@ None #### Request ```ruby -seam.thermostats.set_temperature_threshold(device_id: "123e4567-e89b-12d3-a456-426614174000", lower_limit_celsius: 4, upper_limit_celsius: 30) +seam.thermostats.set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +) ``` #### Response diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index a46f4587..b8c30ff4 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -49,7 +49,12 @@ None #### 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) +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 diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 899da57c..2e4300b3 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.user_identities.add_acs_user(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0") +seam.user_identities.add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +) ``` #### Response diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 3ffba53e..1833ebe7 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -67,13 +67,27 @@ UserIdentity( #### Request ```ruby -seam.user_identities.create(user_identity_key: "jean_doe", email_address: "jean@example.com", phone_number: "+15555550110", full_name: "Jean Doe") +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"} +{ + "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 %} diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index db137899..36c19aa0 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -43,7 +43,9 @@ None #### Request ```ruby -seam.user_identities.enrollment_automations.delete(enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895") +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) ``` #### Response diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 7723b5ea..cfb16426 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -59,13 +59,23 @@ EnrollmentAutomation( #### Request ```ruby -seam.user_identities.enrollment_automations.get(enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895") +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"} +{ + "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 %} diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index ffb02bbd..489f4937 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -65,13 +65,26 @@ Unknown( #### 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) +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"} +{ + "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 %} diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index cef36e3a..aa7a4e50 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -63,13 +63,25 @@ seam.user_identities.enrollment_automations.list( #### Request ```ruby -seam.user_identities.enrollment_automations.list(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") +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"}] +[ + { + "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 %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 73a8d8f8..df790265 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -65,7 +65,16 @@ 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"} +{ + "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 %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 799d043a..0ef0494b 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.user_identities.grant_access_to_device(user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", device_id: "054765c8-a2fc-4599-b486-14c19f462c45") +seam.user_identities.grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) ``` #### Response diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 8c1162e7..47244363 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -61,13 +61,24 @@ seam.user_identities.list() #### Request ```ruby -seam.user_identities.list +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"}] +[ + { + "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 %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index dd9408ce..781851f9 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -147,13 +147,71 @@ seam.user_identities.list_accessible_devices( #### Request ```ruby -seam.user_identities.list_accessible_devices(user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf") +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: ["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" => {}}] +[ + { + "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 %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 2c9cfa37..44a9d3f8 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -73,7 +73,19 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f #### 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"]}] +[ + { + "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 %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 5cebba32..d8baa4b3 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -77,7 +77,21 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 #### 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"}] +[ + { + "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 %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 1349d958..4d92e2a7 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.user_identities.remove_acs_user(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe") +seam.user_identities.remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) ``` #### Response diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 58e60e39..707ff15f 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -45,7 +45,10 @@ None #### Request ```ruby -seam.user_identities.revoke_access_to_device(user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", device_id: "054765c8-a2fc-4599-b486-14c19f462c45") +seam.user_identities.revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) ``` #### Response diff --git a/docs/api/user_identities/update-a-user-identity.md b/docs/api/user_identities/update-a-user-identity.md deleted file mode 100644 index 50d02a02..00000000 --- a/docs/api/user_identities/update-a-user-identity.md +++ /dev/null @@ -1,2 +0,0 @@ -# Update a User Identity - From 509578d9726705d431432e516fe4c9c271c0a431 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <84702959+andrii-balitskyi@users.noreply.github.com> Date: Thu, 12 Dec 2024 14:06:30 +0100 Subject: [PATCH 3/3] Update .github/workflows/generate.yml Co-authored-by: Evan Sosenko --- .github/workflows/generate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index 6585eae5..cd675beb 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -49,7 +49,7 @@ jobs: with: go-version: '^1.23.2' - name: Install syntax_tree - run: gem install syntax_tree + run: gem install syntax_tree -v 6.2.0 - name: Normalize package-lock.json run: npm install - name: Generate docs