Merge branch 'main' into add-code-samples-for-thermostats-set_hvac_mode

seamapi · Dec 12, 2024 · c4acf07 · c4acf07
2 parents 647dae3 + 5b9047e
commit c4acf07
Show file tree

Hide file tree

Showing 60 changed files with 625 additions and 104 deletions.
diff --git 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 -v 6.2.0
       - name: Normalize package-lock.json
         run: npm install
       - name: Generate docs

diff --git a/docs/api/_report.md b/docs/api/_report.md
@@ -751,8 +751,6 @@ Items that are intentionally undocumented are not included in this section.
     - `user_identity_id`
 - `/thermostats/cool`
     - `sync`
-- `/thermostats/create_climate_preset`
-    - `manual_override_allowed`
 - `/thermostats/heat`
     - `sync`
 - `/thermostats/heat_cool`
@@ -766,10 +764,6 @@ Items that are intentionally undocumented are not included in this section.
     - `device_id`
     - `fan_mode`
     - `sync`
-- `/thermostats/schedules/create`
-    - `is_override_allowed`
-- `/thermostats/schedules/update`
-    - `is_override_allowed`
 - `/user_identities/list`
     - `credential_manager_acs_system_id`
 - `/user_identities/update`
@@ -822,6 +816,8 @@ These items are deprecated.
     - `email`: use email_address.
 - `/acs/users/update`
     - `email`: use email_address.
+- `/thermostats/create_climate_preset`
+    - `manual_override_allowed`: Use 'thermostat_schedule.is_override_allowed'
 - `/thermostats/set_fan_mode`
     - `fan_mode`: Use `fan_mode_setting` instead.
 - `/thermostats/update_climate_preset`

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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" => "[email protected]", "email_address" => "[email protected]", "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" => "[email protected]", "user_identity_phone_number" => "+15555550100"}]
+[
+  {
+    "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+    "display_name" => "Jane Doe",
+    "full_name" => "Jane Doe",
+    "email" => "[email protected]",
+    "email_address" => "[email protected]",
+    "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" => "[email protected]",
+    "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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 %}