Skip to content

Commit 302d041

Browse files
feat(deps): bump @seamapi/types from 1.413.0 to 1.414.2 (#654)
* feat(deps): bump @seamapi/types from 1.413.0 to 1.414.2 Bumps [@seamapi/types](https://github.com/seamapi/types) from 1.413.0 to 1.414.2. - [Release notes](https://github.com/seamapi/types/releases) - [Changelog](https://github.com/seamapi/types/blob/main/.releaserc.json) - [Commits](seamapi/types@v1.413.0...v1.414.2) --- updated-dependencies: - dependency-name: "@seamapi/types" dependency-version: 1.414.2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * ci: Generate docs --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Seam Bot <[email protected]>
1 parent 38c2483 commit 302d041

File tree

8 files changed

+1224
-39
lines changed

8 files changed

+1224
-39
lines changed

docs/api/_blueprint.json

Lines changed: 1086 additions & 17 deletions
Large diffs are not rendered by default.

docs/api/_report.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,12 @@ These items are intentionally undocumented.
4848

4949
### Resources
5050

51+
- `bridge_client_session`: Seam Bridge Client only.
52+
- `bridge_connected_systems`: Seam Bridge Client only.
5153
- `instant_key`: Unreleased.
54+
- `location`: Will be removed.
5255
- `magic_link`: Unreleased.
56+
- `partner_resource`: Unreleased.
5357
- `phone_session`: Seam Mobile SDK only.
5458

5559
### Resource properties
@@ -186,10 +190,14 @@ Items that are intentionally undocumented are not included in this section.
186190
- `access_method`
187191
- `acs_credential_pool`
188192
- `acs_credential_provisioning_automation`
193+
- `bridge_client_session`
194+
- `bridge_connected_systems`
189195
- `device_provider`
190196
- `event`
191197
- `instant_key`
198+
- `location`
192199
- `magic_link`
200+
- `partner_resource`
193201
- `phone_session`
194202
- `space`
195203
- `unmanaged_acs_access_group`
@@ -225,6 +233,28 @@ Items that are intentionally undocumented are not included in this section.
225233
- `acs_user.email`
226234
- `acs_user.hid_acs_system_id`
227235
- `acs_user.is_managed`
236+
- `bridge_client_session.bridge_client_machine_identifier_key`
237+
- `bridge_client_session.bridge_client_name`
238+
- `bridge_client_session.bridge_client_session_id`
239+
- `bridge_client_session.bridge_client_session_token`
240+
- `bridge_client_session.bridge_client_time_zone`
241+
- `bridge_client_session.created_at`
242+
- `bridge_client_session.errors`
243+
- `bridge_client_session.pairing_code`
244+
- `bridge_client_session.pairing_code_expires_at`
245+
- `bridge_client_session.tailscale_auth_key`
246+
- `bridge_client_session.tailscale_hostname`
247+
- `bridge_client_session.telemetry_token`
248+
- `bridge_client_session.telemetry_token_expires_at`
249+
- `bridge_client_session.telemetry_url`
250+
- `bridge_connected_systems.acs_system_display_name`
251+
- `bridge_connected_systems.acs_system_id`
252+
- `bridge_connected_systems.bridge_created_at`
253+
- `bridge_connected_systems.bridge_id`
254+
- `bridge_connected_systems.connected_account_created_at`
255+
- `bridge_connected_systems.connected_account_id`
256+
- `bridge_connected_systems.workspace_display_name`
257+
- `bridge_connected_systems.workspace_id`
228258
- `client_session.client_session_id`
229259
- `client_session.connect_webview_ids`
230260
- `client_session.connected_account_ids`
@@ -279,6 +309,18 @@ Items that are intentionally undocumented are not included in this section.
279309
- `magic_link.expires_at`
280310
- `magic_link.url`
281311
- `magic_link.workspace_id`
312+
- `partner_resource.custom_metadata`
313+
- `partner_resource.customer_key`
314+
- `partner_resource.description`
315+
- `partner_resource.email_address`
316+
- `partner_resource.ends_at`
317+
- `partner_resource.location_keys`
318+
- `partner_resource.name`
319+
- `partner_resource.partner_resource_key`
320+
- `partner_resource.partner_resource_type`
321+
- `partner_resource.phone_number`
322+
- `partner_resource.starts_at`
323+
- `partner_resource.user_identity_key`
282324
- `phone_session.provider_sessions`
283325
- `unmanaged_acs_access_group.access_group_type`
284326
- `unmanaged_acs_access_group.access_group_type_display_name`
@@ -564,19 +606,7 @@ These items are deprecated.
564606
- `/bridges/list`: `bridges`
565607
- `/networks/get`: `network`
566608
- `/networks/list`: `networks`
567-
- `/seam/bridge/v1/bridge_client_sessions/create`: `bridge_client_session`
568-
- `/seam/bridge/v1/bridge_client_sessions/get`: `bridge_client_session`
569-
- `/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token`: `bridge_client_session`
570-
- `/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code`: `bridge_client_session`
571-
- `/seam/bridge/v1/bridge_connected_systems/list`: `bridge_connected_systems`
572609
- `/seam/partner/v1/building_blocks/spaces/auto_map`: `spaces`
573-
- `/seam/partner/v1/resources/list`: `partner_resources`
574-
- `/thermostats/daily_programs/create`: `thermostat_daily_program`
575-
- `/unstable_locations/create`: `location`
576-
- `/unstable_locations/get`: `location`
577-
- `/unstable_locations/list`: `locations`
578-
- `/unstable_locations/update`: `location`
579-
- `/user_identities/enrollment_automations/launch`: `enrollment_automation`
580610

581611
### Endpoints without code samples
582612

docs/api/acs/entrances/list.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,18 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
195195

196196
## Request Parameters
197197

198+
**`access_grant_id`** *String*
199+
200+
ID of the access grant for which you want to retrieve all entrances.
201+
202+
---
203+
204+
**`access_method_id`** *String*
205+
206+
ID of the access method for which you want to retrieve all entrances.
207+
208+
---
209+
198210
**`acs_credential_id`** *String*
199211

200212
ID of the credential for which you want to retrieve all entrances.

docs/api/user_identities/README.md

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,26 @@ Unique email address for the user identity.
3838

3939

4040

41+
---
42+
43+
**`errors`** *List* *of Objects*
44+
45+
Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
46+
47+
48+
49+
<details>
50+
<summary>Child Object Properties</summary>
51+
52+
<strong><code>created_at</code></strong> <i>Datetime</i>
53+
54+
Date and time at which Seam created the error.
55+
56+
<strong><code>message</code></strong> <i>String</i>
57+
58+
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
59+
</details>
60+
4161
---
4262

4363
**`full_name`** *String*
@@ -73,6 +93,51 @@ Unique key for the user identity.
7393

7494

7595

96+
---
97+
98+
[**`warnings`**](./#warnings) *List* *of Objects*
99+
100+
Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
101+
102+
103+
104+
105+
The specific structure of each object in this list depends on the value of its `warning_code` field.
106+
107+
Variants:
108+
<details>
109+
<summary><code>being_deleted</code></summary>
110+
111+
Indicates that the user identity is currently being deleted.
112+
113+
**`created_at`** *Datetime*
114+
115+
116+
Date and time at which Seam created the warning.
117+
118+
119+
---
120+
121+
**`message`** *String*
122+
123+
124+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
125+
126+
127+
---
128+
129+
**`warning_code`** *Enum*
130+
131+
132+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
133+
134+
Enum values:
135+
136+
- <code>being_deleted</code>
137+
138+
139+
</details>
140+
76141
---
77142

78143
**`workspace_id`** *UUID*
@@ -82,6 +147,15 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th
82147

83148

84149

150+
---
151+
152+
153+
## Warnings
154+
155+
**`being_deleted`**
156+
157+
Indicates that the user identity is currently being deleted.
158+
85159
---
86160

87161
## Endpoints
@@ -99,7 +173,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobi
99173

100174
[**`/user_identities/delete`**](./delete.md)
101175

102-
Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
176+
Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).
103177

104178

105179
[**`/user_identities/generate_instant_key`**](./generate_instant_key.md)

docs/api/user_identities/delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- [Response](./#response)
55
- [Examples](./#examples)
66

7-
Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
7+
Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).
88

99

1010
{% tabs %}

docs/api/user_identities/enrollment_automations/launch.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ seam.user_identities.enrollment_automations.launch(
9292
#### Output
9393

9494
```python
95-
Unknown(
95+
EnrollmentAutomation(
9696
user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f",
9797
enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895",
9898
acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895",
@@ -196,7 +196,7 @@ func main() {
196196
#### Output
197197

198198
```go
199-
api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
199+
api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
200200
```
201201
{% endtab %}
202202

@@ -274,7 +274,7 @@ ID of the associated access system user within the credential manager. If you sp
274274

275275
## Response
276276

277-
[unknown](./)
277+
[enrollment\_automation](./)
278278

279279

280280
---

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"@prettier/plugin-ruby": "^4.0.4",
3535
"@seamapi/blueprint": "^0.48.0",
3636
"@seamapi/smith": "^0.4.4",
37-
"@seamapi/types": "1.413.0",
37+
"@seamapi/types": "1.414.2",
3838
"change-case": "^5.4.4",
3939
"command-exists": "^1.2.9",
4040
"execa": "^9.3.1",

0 commit comments

Comments
 (0)