Skip to content

Commit a6c1547

Browse files
razor-xseambot
andauthored
Update types and blueprint (#617)
* Update blueprint * Update types to v1.406.2 * Move pagination docs to src/docs/api * Filter out unstable_ namespace * Move pagination to api-overview * Update package-lock * Check if namespace is documented * Update types * Update types * ci: Generate docs * Simplify getNamespacePaths --------- Co-authored-by: Seam Bot <seambot@getseam.com>
1 parent a08a02a commit a6c1547

31 files changed

Lines changed: 2131 additions & 1381 deletions

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@
131131
* [Overview](api-clients/overview.md)
132132
* [Installation](api-clients/installation.md)
133133
* [Authentication](api-clients/authentication.md)
134-
* [Pagination](api/pagination.md)
134+
* [Pagination](api-overview/pagination.md)
135135
* [Access Codes](api/access_codes/README.md)
136136
* [Create an Access Code](api/access_codes/create.md)
137137
* [Create Multiple Linked Access Codes](api/access_codes/create_multiple.md)
File renamed without changes.

docs/api/_blueprint.json

Lines changed: 1740 additions & 975 deletions
Large diffs are not rendered by default.

docs/api/_report.md

Lines changed: 22 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,11 @@ These items are intentionally undocumented.
6565
- `/seam/instant_key/v1/client_sessions`: No undocumented message provided
6666
- `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided
6767
- `/seam/mobile_sdk/v1/phone_sessions`: No undocumented message provided
68+
- `/seam/partner/v1/resources`: No undocumented message provided
6869
- `/unstable_access_grants`: No undocumented message provided
6970
- `/unstable_access_methods`: No undocumented message provided
7071
- `/unstable_locations`: No undocumented message provided
72+
- `/unstable_partner/building_blocks`: No undocumented message provided
7173
- `/unstable_partner/resources`: No undocumented message provided
7274

7375
### Resources
@@ -88,6 +90,7 @@ These items are intentionally undocumented.
8890
- `/seam/instant_key/v1`: No undocumented message provided
8991
- `/seam/mobile_sdk/v1/acs`: No undocumented message provided
9092
- `/seam/mobile_sdk/v1`: No undocumented message provided
93+
- `/seam/partner/v1`: No undocumented message provided
9194
- `/unstable_partner`: No undocumented message provided
9295

9396
### Endpoints
@@ -115,10 +118,13 @@ These items are intentionally undocumented.
115118
- `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only.
116119
- `/seam/mobile_sdk/v1/acs/credentials/list`: Mobile SDK only.
117120
- `/seam/mobile_sdk/v1/phone_sessions/get_or_create`: Mobile SDK only.
121+
- `/seam/partner/v1/resources/list`: Partner building blocks/UI only.
118122
- `/thermostats/get`: Will be removed.
119123
- `/unstable_access_grants/create`: Unreleased.
124+
- `/unstable_access_grants/delete`: Unreleased.
120125
- `/unstable_access_grants/get`: Unreleased.
121126
- `/unstable_access_grants/list`: Unreleased.
127+
- `/unstable_access_methods/delete`: Unreleased.
122128
- `/unstable_access_methods/get`: Unreleased.
123129
- `/unstable_access_methods/list`: Unreleased.
124130
- `/unstable_locations/add_acs_entrances`: Experimental locations.
@@ -130,6 +136,7 @@ These items are intentionally undocumented.
130136
- `/unstable_locations/remove_acs_entrances`: Experimental locations.
131137
- `/unstable_locations/remove_devices`: Experimental locations.
132138
- `/unstable_locations/update`: Experimental locations.
139+
- `/unstable_partner/building_blocks/generate_link`: Experimental partner building blocks.
133140
- `/unstable_partner/resources/push`: Experimental partner resources.
134141

135142
### Endpoint parameters
@@ -221,12 +228,6 @@ Items that are intentionally undocumented are not included in this section.
221228
- `acs_credential_provisioning_automation.workspace_id`
222229
- `acs_system.acs_access_group_count`
223230
- `acs_system.acs_user_count`
224-
- `acs_system.can_create_user`
225-
- `acs_system.can_delete_user`
226-
- `acs_system.can_update_user_group_membership`
227-
- `acs_system.can_update_user_information`
228-
- `acs_system.can_update_user_schedule`
229-
- `acs_system.can_update_user_supension_state`
230231
- `acs_system.location`
231232
- `acs_system.system_type`
232233
- `acs_system.system_type_display_name`
@@ -245,33 +246,8 @@ Items that are intentionally undocumented are not included in this section.
245246
- `client_session.user_identity_ids`
246247
- `client_session.workspace_id`
247248
- `connect_webview.accepted_devices`
248-
- `connect_webview.accepted_providers`
249249
- `connect_webview.any_device_allowed`
250-
- `connect_webview.any_provider_allowed`
251-
- `connect_webview.authorized_at`
252-
- `connect_webview.automatically_manage_new_devices`
253-
- `connect_webview.connect_webview_id`
254-
- `connect_webview.connected_account_id`
255-
- `connect_webview.created_at`
256-
- `connect_webview.custom_metadata`
257-
- `connect_webview.custom_redirect_failure_url`
258-
- `connect_webview.custom_redirect_url`
259250
- `connect_webview.device_selection_mode`
260-
- `connect_webview.login_successful`
261-
- `connect_webview.selected_provider`
262-
- `connect_webview.status`
263-
- `connect_webview.url`
264-
- `connect_webview.wait_for_device_creation`
265-
- `connect_webview.workspace_id`
266-
- `connected_account.account_type`
267-
- `connected_account.account_type_display_name`
268-
- `connected_account.automatically_manage_new_devices`
269-
- `connected_account.connected_account_id`
270-
- `connected_account.created_at`
271-
- `connected_account.custom_metadata`
272-
- `connected_account.errors`
273-
- `connected_account.user_identifier`
274-
- `connected_account.warnings`
275251
- `device.can_hvac_cool`
276252
- `device.can_hvac_heat`
277253
- `device.can_hvac_heat_cool`
@@ -283,7 +259,6 @@ Items that are intentionally undocumented are not included in this section.
283259
- `device.can_simulate_disconnection`
284260
- `device.can_simulate_removal`
285261
- `device.can_turn_off_hvac`
286-
- `device.custom_metadata`
287262
- `device_provider.can_hvac_cool`
288263
- `device_provider.can_hvac_heat`
289264
- `device_provider.can_hvac_heat_cool`
@@ -340,7 +315,6 @@ Items that are intentionally undocumented are not included in this section.
340315
- `unmanaged_device.can_simulate_removal`
341316
- `unmanaged_device.can_turn_off_hvac`
342317
- `unmanaged_device.is_managed`
343-
- `unmanaged_device.properties`
344318
- `user_identity.display_name`
345319
- `user_identity.full_name`
346320
- `webhook.event_types`
@@ -411,8 +385,14 @@ Items that are intentionally undocumented are not included in this section.
411385
- `/acs/users/update`
412386
- `email`
413387
- `hid_acs_system_id`
388+
- `/client_sessions/create`
389+
- `customer_id`
390+
- `customer_key`
414391
- `/connect_webviews/create`
392+
- `customer_id`
415393
- `device_selection_mode`
394+
- `/connect_webviews/list`
395+
- `customer_id`
416396
- `/connected_accounts/delete`
417397
- `sync`
418398
- `/connected_accounts/list`
@@ -427,27 +407,6 @@ Items that are intentionally undocumented are not included in this section.
427407
- `customer_ids`
428408
- `exclude_if`
429409
- `include_if`
430-
- `/events/get`
431-
- `device_id`
432-
- `event_id`
433-
- `event_type`
434-
- `/events/list`
435-
- `access_code_id`
436-
- `access_code_ids`
437-
- `acs_system_id`
438-
- `acs_system_ids`
439-
- `between`
440-
- `connect_webview_id`
441-
- `connected_account_id`
442-
- `customer_ids`
443-
- `device_id`
444-
- `device_ids`
445-
- `event_ids`
446-
- `event_type`
447-
- `event_types`
448-
- `limit`
449-
- `since`
450-
- `unstable_offset`
451410
- `/locks/get`
452411
- `device_id`
453412
- `name`
@@ -557,13 +516,16 @@ Items that are intentionally undocumented are not included in this section.
557516
- `location_id`
558517
- `name`
559518
- `time_zone`
519+
- `/unstable_partner/building_blocks/generate_link`
520+
- `bridge_client_machine_identifier_key`
521+
- `bridge_client_name`
522+
- `bridge_client_time_zone`
560523
- `/unstable_partner/resources/push`
561524
- `custom_metadata`
562525
- `customer_key`
563526
- `description`
564527
- `email_address`
565528
- `ends_at`
566-
- `icon_url`
567529
- `location_keys`
568530
- `name`
569531
- `partner_resource_key`
@@ -725,6 +687,7 @@ These items are deprecated.
725687
- `/connected_accounts/delete`
726688
- `/connected_accounts/get`
727689
- `/connected_accounts/list`
690+
- `/connected_accounts/sync`
728691
- `/connected_accounts/update`
729692
- `/devices/delete`
730693
- `/devices/get`
@@ -767,6 +730,7 @@ These items are deprecated.
767730
- `/seam/instant_key/v1/client_sessions/exchange_short_code`
768731
- `/seam/mobile_sdk/v1/acs/credentials/list`
769732
- `/seam/mobile_sdk/v1/phone_sessions/get_or_create`
733+
- `/seam/partner/v1/resources/list`
770734
- `/thermostats/get`
771735
- `/thermostats/update_weekly_program`
772736
- `/thermostats/daily_programs/create`
@@ -775,8 +739,10 @@ These items are deprecated.
775739
- `/thermostats/simulate/hvac_mode_adjusted`
776740
- `/thermostats/simulate/temperature_reached`
777741
- `/unstable_access_grants/create`
742+
- `/unstable_access_grants/delete`
778743
- `/unstable_access_grants/get`
779744
- `/unstable_access_grants/list`
745+
- `/unstable_access_methods/delete`
780746
- `/unstable_access_methods/get`
781747
- `/unstable_access_methods/list`
782748
- `/unstable_locations/add_acs_entrances`
@@ -788,6 +754,7 @@ These items are deprecated.
788754
- `/unstable_locations/remove_acs_entrances`
789755
- `/unstable_locations/remove_devices`
790756
- `/unstable_locations/update`
757+
- `/unstable_partner/building_blocks/generate_link`
791758
- `/unstable_partner/resources/push`
792759
- `/user_identities/generate_instant_key`
793760
- `/user_identities/update`

0 commit comments

Comments
 (0)