@seamapi/types 1.381.0 → 1.383.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +285 -10
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +353 -2
- package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +9 -0
- package/lib/seam/connect/models/bridges/bridge-client-session.js +3 -0
- package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
- package/lib/seam/connect/models/events/acs/index.d.ts +30 -0
- package/lib/seam/connect/models/events/acs/users.d.ts +62 -0
- package/lib/seam/connect/models/events/acs/users.js +12 -1
- package/lib/seam/connect/models/events/acs/users.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +31 -1
- package/lib/seam/connect/openapi.d.ts +226 -0
- package/lib/seam/connect/openapi.js +261 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +88 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +3 -0
- package/src/lib/seam/connect/models/events/acs/users.ts +15 -1
- package/src/lib/seam/connect/openapi.ts +278 -0
- package/src/lib/seam/connect/route-types.ts +93 -0
|
@@ -18934,6 +18934,21 @@ export interface Routes {
|
|
|
18934
18934
|
acs_system_id: string;
|
|
18935
18935
|
acs_credential_id: string;
|
|
18936
18936
|
event_type: 'acs_credential.invalidated';
|
|
18937
|
+
} | {
|
|
18938
|
+
/** ID of the event. */
|
|
18939
|
+
event_id: string;
|
|
18940
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
|
|
18941
|
+
workspace_id: string;
|
|
18942
|
+
/** Date and time at which the event was created. */
|
|
18943
|
+
created_at: string;
|
|
18944
|
+
/** Date and time at which the event occurred. */
|
|
18945
|
+
occurred_at: string;
|
|
18946
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
|
|
18947
|
+
connected_account_id?: string | undefined;
|
|
18948
|
+
/** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
18949
|
+
acs_system_id: string;
|
|
18950
|
+
acs_user_id: string;
|
|
18951
|
+
event_type: 'acs_user.created';
|
|
18937
18952
|
} | {
|
|
18938
18953
|
/** ID of the event. */
|
|
18939
18954
|
event_id: string;
|
|
@@ -19817,8 +19832,8 @@ export interface Routes {
|
|
|
19817
19832
|
acs_system_ids?: string[] | undefined;
|
|
19818
19833
|
access_code_id?: string | undefined;
|
|
19819
19834
|
access_code_ids?: string[] | undefined;
|
|
19820
|
-
event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated') | undefined;
|
|
19821
|
-
event_types?: Array<'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated'> | undefined;
|
|
19835
|
+
event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated') | undefined;
|
|
19836
|
+
event_types?: Array<'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated'> | undefined;
|
|
19822
19837
|
connected_account_id?: string | undefined;
|
|
19823
19838
|
connect_webview_id?: string | undefined;
|
|
19824
19839
|
limit?: number;
|
|
@@ -20207,6 +20222,21 @@ export interface Routes {
|
|
|
20207
20222
|
acs_system_id: string;
|
|
20208
20223
|
acs_credential_id: string;
|
|
20209
20224
|
event_type: 'acs_credential.invalidated';
|
|
20225
|
+
} | {
|
|
20226
|
+
/** ID of the event. */
|
|
20227
|
+
event_id: string;
|
|
20228
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
|
|
20229
|
+
workspace_id: string;
|
|
20230
|
+
/** Date and time at which the event was created. */
|
|
20231
|
+
created_at: string;
|
|
20232
|
+
/** Date and time at which the event occurred. */
|
|
20233
|
+
occurred_at: string;
|
|
20234
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
|
|
20235
|
+
connected_account_id?: string | undefined;
|
|
20236
|
+
/** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
20237
|
+
acs_system_id: string;
|
|
20238
|
+
acs_user_id: string;
|
|
20239
|
+
event_type: 'acs_user.created';
|
|
20210
20240
|
} | {
|
|
20211
20241
|
/** ID of the event. */
|
|
20212
20242
|
event_id: string;
|
|
@@ -30572,6 +30602,9 @@ export interface Routes {
|
|
|
30572
30602
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
30573
30603
|
error_code: 'no_communication_from_bridge';
|
|
30574
30604
|
}>;
|
|
30605
|
+
telemetry_token: string | null;
|
|
30606
|
+
telemetry_token_expires_at: string | null;
|
|
30607
|
+
telemetry_url: string | null;
|
|
30575
30608
|
};
|
|
30576
30609
|
};
|
|
30577
30610
|
};
|
|
@@ -30616,6 +30649,56 @@ export interface Routes {
|
|
|
30616
30649
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
30617
30650
|
error_code: 'no_communication_from_bridge';
|
|
30618
30651
|
}>;
|
|
30652
|
+
telemetry_token: string | null;
|
|
30653
|
+
telemetry_token_expires_at: string | null;
|
|
30654
|
+
telemetry_url: string | null;
|
|
30655
|
+
};
|
|
30656
|
+
};
|
|
30657
|
+
};
|
|
30658
|
+
'/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
|
|
30659
|
+
route: '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token';
|
|
30660
|
+
method: 'POST';
|
|
30661
|
+
queryParams: {};
|
|
30662
|
+
jsonBody: {};
|
|
30663
|
+
commonParams: {};
|
|
30664
|
+
formData: {};
|
|
30665
|
+
jsonResponse: {
|
|
30666
|
+
/** */
|
|
30667
|
+
bridge_client_session: {
|
|
30668
|
+
created_at: string;
|
|
30669
|
+
bridge_client_session_id: string;
|
|
30670
|
+
bridge_client_session_token: string;
|
|
30671
|
+
pairing_code: string;
|
|
30672
|
+
pairing_code_expires_at: string;
|
|
30673
|
+
tailscale_hostname: string;
|
|
30674
|
+
tailscale_auth_key: string | null;
|
|
30675
|
+
bridge_client_name: string;
|
|
30676
|
+
bridge_client_time_zone: string;
|
|
30677
|
+
bridge_client_machine_identifier_key: string;
|
|
30678
|
+
errors: Array<{
|
|
30679
|
+
message: string;
|
|
30680
|
+
created_at: string;
|
|
30681
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
30682
|
+
error_code: 'bridge_lan_unreachable';
|
|
30683
|
+
/** Seam cannot reach the tailscale proxy */
|
|
30684
|
+
is_tailscale_proxy_reachable: boolean | null;
|
|
30685
|
+
/** Tailscale proxy's SOCKS server is unhealthy */
|
|
30686
|
+
is_tailscale_proxy_socks_server_healthy: boolean | null;
|
|
30687
|
+
/** Tailscale proxy cannot reach the Tailscale network */
|
|
30688
|
+
can_tailscale_proxy_reach_tailscale_network: boolean | null;
|
|
30689
|
+
/** Tailscale proxy cannot reach the bridge */
|
|
30690
|
+
can_tailscale_proxy_reach_bridge: boolean | null;
|
|
30691
|
+
/** Bridge's SOCKS server is unhealthy */
|
|
30692
|
+
is_bridge_socks_server_healthy: boolean | null;
|
|
30693
|
+
} | {
|
|
30694
|
+
message: string;
|
|
30695
|
+
created_at: string;
|
|
30696
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
30697
|
+
error_code: 'no_communication_from_bridge';
|
|
30698
|
+
}>;
|
|
30699
|
+
telemetry_token: string | null;
|
|
30700
|
+
telemetry_token_expires_at: string | null;
|
|
30701
|
+
telemetry_url: string | null;
|
|
30619
30702
|
};
|
|
30620
30703
|
};
|
|
30621
30704
|
};
|
|
@@ -30660,6 +30743,9 @@ export interface Routes {
|
|
|
30660
30743
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
30661
30744
|
error_code: 'no_communication_from_bridge';
|
|
30662
30745
|
}>;
|
|
30746
|
+
telemetry_token: string | null;
|
|
30747
|
+
telemetry_token_expires_at: string | null;
|
|
30748
|
+
telemetry_url: string | null;
|
|
30663
30749
|
};
|
|
30664
30750
|
};
|
|
30665
30751
|
};
|
package/package.json
CHANGED
|
@@ -78,6 +78,9 @@ export const bridge_client_session = z.object({
|
|
|
78
78
|
bridge_client_time_zone: z.string(),
|
|
79
79
|
bridge_client_machine_identifier_key: z.string(),
|
|
80
80
|
errors: z.array(bridge_client_session_error),
|
|
81
|
+
telemetry_token: z.string().nullable(),
|
|
82
|
+
telemetry_token_expires_at: z.string().datetime().nullable(),
|
|
83
|
+
telemetry_url: z.string().nullable(),
|
|
81
84
|
}).describe(`
|
|
82
85
|
---
|
|
83
86
|
route_path: /seam/bridge/v1/bridge_client_sessions
|
|
@@ -21,4 +21,18 @@ export const acs_user_deleted_event = acs_user_event.extend({
|
|
|
21
21
|
|
|
22
22
|
export type AcsUserDeletedEvent = z.infer<typeof acs_user_deleted_event>
|
|
23
23
|
|
|
24
|
-
export const
|
|
24
|
+
export const acs_user_created_event = acs_user_event.extend({
|
|
25
|
+
event_type: z.literal('acs_user.created'),
|
|
26
|
+
}).describe(`
|
|
27
|
+
---
|
|
28
|
+
route_path: /acs/users
|
|
29
|
+
---
|
|
30
|
+
An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
|
|
31
|
+
`)
|
|
32
|
+
|
|
33
|
+
export type AcsUserCreatedEvent = z.infer<typeof acs_user_created_event>
|
|
34
|
+
|
|
35
|
+
export const acs_user_events = [
|
|
36
|
+
acs_user_created_event,
|
|
37
|
+
acs_user_deleted_event,
|
|
38
|
+
] as const
|
|
@@ -10448,6 +10448,58 @@ export default {
|
|
|
10448
10448
|
type: 'object',
|
|
10449
10449
|
'x-route-path': '/acs/credentials',
|
|
10450
10450
|
},
|
|
10451
|
+
{
|
|
10452
|
+
description:
|
|
10453
|
+
'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
|
|
10454
|
+
properties: {
|
|
10455
|
+
acs_system_id: {
|
|
10456
|
+
description:
|
|
10457
|
+
'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
10458
|
+
format: 'uuid',
|
|
10459
|
+
type: 'string',
|
|
10460
|
+
},
|
|
10461
|
+
acs_user_id: { format: 'uuid', type: 'string' },
|
|
10462
|
+
connected_account_id: {
|
|
10463
|
+
description:
|
|
10464
|
+
'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
10465
|
+
format: 'uuid',
|
|
10466
|
+
type: 'string',
|
|
10467
|
+
},
|
|
10468
|
+
created_at: {
|
|
10469
|
+
description: 'Date and time at which the event was created.',
|
|
10470
|
+
format: 'date-time',
|
|
10471
|
+
type: 'string',
|
|
10472
|
+
},
|
|
10473
|
+
event_id: {
|
|
10474
|
+
description: 'ID of the event.',
|
|
10475
|
+
format: 'uuid',
|
|
10476
|
+
type: 'string',
|
|
10477
|
+
},
|
|
10478
|
+
event_type: { enum: ['acs_user.created'], type: 'string' },
|
|
10479
|
+
occurred_at: {
|
|
10480
|
+
description: 'Date and time at which the event occurred.',
|
|
10481
|
+
format: 'date-time',
|
|
10482
|
+
type: 'string',
|
|
10483
|
+
},
|
|
10484
|
+
workspace_id: {
|
|
10485
|
+
description:
|
|
10486
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
|
|
10487
|
+
format: 'uuid',
|
|
10488
|
+
type: 'string',
|
|
10489
|
+
},
|
|
10490
|
+
},
|
|
10491
|
+
required: [
|
|
10492
|
+
'event_id',
|
|
10493
|
+
'workspace_id',
|
|
10494
|
+
'created_at',
|
|
10495
|
+
'occurred_at',
|
|
10496
|
+
'acs_system_id',
|
|
10497
|
+
'acs_user_id',
|
|
10498
|
+
'event_type',
|
|
10499
|
+
],
|
|
10500
|
+
type: 'object',
|
|
10501
|
+
'x-route-path': '/acs/users',
|
|
10502
|
+
},
|
|
10451
10503
|
{
|
|
10452
10504
|
description:
|
|
10453
10505
|
'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.',
|
|
@@ -25525,6 +25577,7 @@ export default {
|
|
|
25525
25577
|
'acs_credential.issued',
|
|
25526
25578
|
'acs_credential.reissued',
|
|
25527
25579
|
'acs_credential.invalidated',
|
|
25580
|
+
'acs_user.created',
|
|
25528
25581
|
'acs_user.deleted',
|
|
25529
25582
|
'acs_encoder.added',
|
|
25530
25583
|
'acs_encoder.removed',
|
|
@@ -25610,6 +25663,7 @@ export default {
|
|
|
25610
25663
|
'acs_credential.issued',
|
|
25611
25664
|
'acs_credential.reissued',
|
|
25612
25665
|
'acs_credential.invalidated',
|
|
25666
|
+
'acs_user.created',
|
|
25613
25667
|
'acs_user.deleted',
|
|
25614
25668
|
'acs_encoder.added',
|
|
25615
25669
|
'acs_encoder.removed',
|
|
@@ -27258,6 +27312,13 @@ export default {
|
|
|
27258
27312
|
},
|
|
27259
27313
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
27260
27314
|
tailscale_hostname: { type: 'string' },
|
|
27315
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
27316
|
+
telemetry_token_expires_at: {
|
|
27317
|
+
format: 'date-time',
|
|
27318
|
+
nullable: true,
|
|
27319
|
+
type: 'string',
|
|
27320
|
+
},
|
|
27321
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
27261
27322
|
},
|
|
27262
27323
|
required: [
|
|
27263
27324
|
'created_at',
|
|
@@ -27271,6 +27332,9 @@ export default {
|
|
|
27271
27332
|
'bridge_client_time_zone',
|
|
27272
27333
|
'bridge_client_machine_identifier_key',
|
|
27273
27334
|
'errors',
|
|
27335
|
+
'telemetry_token',
|
|
27336
|
+
'telemetry_token_expires_at',
|
|
27337
|
+
'telemetry_url',
|
|
27274
27338
|
],
|
|
27275
27339
|
type: 'object',
|
|
27276
27340
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -27430,6 +27494,13 @@ export default {
|
|
|
27430
27494
|
},
|
|
27431
27495
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
27432
27496
|
tailscale_hostname: { type: 'string' },
|
|
27497
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
27498
|
+
telemetry_token_expires_at: {
|
|
27499
|
+
format: 'date-time',
|
|
27500
|
+
nullable: true,
|
|
27501
|
+
type: 'string',
|
|
27502
|
+
},
|
|
27503
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
27433
27504
|
},
|
|
27434
27505
|
required: [
|
|
27435
27506
|
'created_at',
|
|
@@ -27443,6 +27514,9 @@ export default {
|
|
|
27443
27514
|
'bridge_client_time_zone',
|
|
27444
27515
|
'bridge_client_machine_identifier_key',
|
|
27445
27516
|
'errors',
|
|
27517
|
+
'telemetry_token',
|
|
27518
|
+
'telemetry_token_expires_at',
|
|
27519
|
+
'telemetry_url',
|
|
27446
27520
|
],
|
|
27447
27521
|
type: 'object',
|
|
27448
27522
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -27593,6 +27667,13 @@ export default {
|
|
|
27593
27667
|
},
|
|
27594
27668
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
27595
27669
|
tailscale_hostname: { type: 'string' },
|
|
27670
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
27671
|
+
telemetry_token_expires_at: {
|
|
27672
|
+
format: 'date-time',
|
|
27673
|
+
nullable: true,
|
|
27674
|
+
type: 'string',
|
|
27675
|
+
},
|
|
27676
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
27596
27677
|
},
|
|
27597
27678
|
required: [
|
|
27598
27679
|
'created_at',
|
|
@@ -27606,6 +27687,9 @@ export default {
|
|
|
27606
27687
|
'bridge_client_time_zone',
|
|
27607
27688
|
'bridge_client_machine_identifier_key',
|
|
27608
27689
|
'errors',
|
|
27690
|
+
'telemetry_token',
|
|
27691
|
+
'telemetry_token_expires_at',
|
|
27692
|
+
'telemetry_url',
|
|
27609
27693
|
],
|
|
27610
27694
|
type: 'object',
|
|
27611
27695
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -27639,6 +27723,190 @@ export default {
|
|
|
27639
27723
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
27640
27724
|
},
|
|
27641
27725
|
},
|
|
27726
|
+
'/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
|
|
27727
|
+
post: {
|
|
27728
|
+
description:
|
|
27729
|
+
'Returns the bridge client session associated with the session token and refreshed telemetry token.',
|
|
27730
|
+
operationId:
|
|
27731
|
+
'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
|
|
27732
|
+
responses: {
|
|
27733
|
+
200: {
|
|
27734
|
+
content: {
|
|
27735
|
+
'application/json': {
|
|
27736
|
+
schema: {
|
|
27737
|
+
properties: {
|
|
27738
|
+
bridge_client_session: {
|
|
27739
|
+
properties: {
|
|
27740
|
+
bridge_client_machine_identifier_key: {
|
|
27741
|
+
type: 'string',
|
|
27742
|
+
},
|
|
27743
|
+
bridge_client_name: { type: 'string' },
|
|
27744
|
+
bridge_client_session_id: {
|
|
27745
|
+
format: 'uuid',
|
|
27746
|
+
type: 'string',
|
|
27747
|
+
},
|
|
27748
|
+
bridge_client_session_token: { type: 'string' },
|
|
27749
|
+
bridge_client_time_zone: { type: 'string' },
|
|
27750
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
27751
|
+
errors: {
|
|
27752
|
+
items: {
|
|
27753
|
+
description:
|
|
27754
|
+
'Error associated with the `bridge_client_session`.',
|
|
27755
|
+
discriminator: { propertyName: 'error_code' },
|
|
27756
|
+
oneOf: [
|
|
27757
|
+
{
|
|
27758
|
+
description:
|
|
27759
|
+
"Seam cannot reach the bridge's LAN",
|
|
27760
|
+
properties: {
|
|
27761
|
+
can_tailscale_proxy_reach_bridge: {
|
|
27762
|
+
description:
|
|
27763
|
+
'Tailscale proxy cannot reach the bridge',
|
|
27764
|
+
nullable: true,
|
|
27765
|
+
type: 'boolean',
|
|
27766
|
+
},
|
|
27767
|
+
can_tailscale_proxy_reach_tailscale_network: {
|
|
27768
|
+
description:
|
|
27769
|
+
'Tailscale proxy cannot reach the Tailscale network',
|
|
27770
|
+
nullable: true,
|
|
27771
|
+
type: 'boolean',
|
|
27772
|
+
},
|
|
27773
|
+
created_at: {
|
|
27774
|
+
format: 'date-time',
|
|
27775
|
+
type: 'string',
|
|
27776
|
+
},
|
|
27777
|
+
error_code: {
|
|
27778
|
+
description:
|
|
27779
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27780
|
+
enum: ['bridge_lan_unreachable'],
|
|
27781
|
+
type: 'string',
|
|
27782
|
+
},
|
|
27783
|
+
is_bridge_socks_server_healthy: {
|
|
27784
|
+
description:
|
|
27785
|
+
"Bridge's SOCKS server is unhealthy",
|
|
27786
|
+
nullable: true,
|
|
27787
|
+
type: 'boolean',
|
|
27788
|
+
},
|
|
27789
|
+
is_tailscale_proxy_reachable: {
|
|
27790
|
+
description:
|
|
27791
|
+
'Seam cannot reach the tailscale proxy',
|
|
27792
|
+
nullable: true,
|
|
27793
|
+
type: 'boolean',
|
|
27794
|
+
},
|
|
27795
|
+
is_tailscale_proxy_socks_server_healthy: {
|
|
27796
|
+
description:
|
|
27797
|
+
"Tailscale proxy's SOCKS server is unhealthy",
|
|
27798
|
+
nullable: true,
|
|
27799
|
+
type: 'boolean',
|
|
27800
|
+
},
|
|
27801
|
+
message: { type: 'string' },
|
|
27802
|
+
},
|
|
27803
|
+
required: [
|
|
27804
|
+
'message',
|
|
27805
|
+
'created_at',
|
|
27806
|
+
'error_code',
|
|
27807
|
+
'is_tailscale_proxy_reachable',
|
|
27808
|
+
'is_tailscale_proxy_socks_server_healthy',
|
|
27809
|
+
'can_tailscale_proxy_reach_tailscale_network',
|
|
27810
|
+
'can_tailscale_proxy_reach_bridge',
|
|
27811
|
+
'is_bridge_socks_server_healthy',
|
|
27812
|
+
],
|
|
27813
|
+
type: 'object',
|
|
27814
|
+
},
|
|
27815
|
+
{
|
|
27816
|
+
description:
|
|
27817
|
+
'Bridge has stopped communicating with Seam',
|
|
27818
|
+
properties: {
|
|
27819
|
+
created_at: {
|
|
27820
|
+
format: 'date-time',
|
|
27821
|
+
type: 'string',
|
|
27822
|
+
},
|
|
27823
|
+
error_code: {
|
|
27824
|
+
description:
|
|
27825
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27826
|
+
enum: ['no_communication_from_bridge'],
|
|
27827
|
+
type: 'string',
|
|
27828
|
+
},
|
|
27829
|
+
message: { type: 'string' },
|
|
27830
|
+
},
|
|
27831
|
+
required: [
|
|
27832
|
+
'message',
|
|
27833
|
+
'created_at',
|
|
27834
|
+
'error_code',
|
|
27835
|
+
],
|
|
27836
|
+
type: 'object',
|
|
27837
|
+
},
|
|
27838
|
+
],
|
|
27839
|
+
},
|
|
27840
|
+
type: 'array',
|
|
27841
|
+
},
|
|
27842
|
+
pairing_code: {
|
|
27843
|
+
maxLength: 6,
|
|
27844
|
+
minLength: 6,
|
|
27845
|
+
type: 'string',
|
|
27846
|
+
},
|
|
27847
|
+
pairing_code_expires_at: {
|
|
27848
|
+
format: 'date-time',
|
|
27849
|
+
type: 'string',
|
|
27850
|
+
},
|
|
27851
|
+
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
27852
|
+
tailscale_hostname: { type: 'string' },
|
|
27853
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
27854
|
+
telemetry_token_expires_at: {
|
|
27855
|
+
format: 'date-time',
|
|
27856
|
+
nullable: true,
|
|
27857
|
+
type: 'string',
|
|
27858
|
+
},
|
|
27859
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
27860
|
+
},
|
|
27861
|
+
required: [
|
|
27862
|
+
'created_at',
|
|
27863
|
+
'bridge_client_session_id',
|
|
27864
|
+
'bridge_client_session_token',
|
|
27865
|
+
'pairing_code',
|
|
27866
|
+
'pairing_code_expires_at',
|
|
27867
|
+
'tailscale_hostname',
|
|
27868
|
+
'tailscale_auth_key',
|
|
27869
|
+
'bridge_client_name',
|
|
27870
|
+
'bridge_client_time_zone',
|
|
27871
|
+
'bridge_client_machine_identifier_key',
|
|
27872
|
+
'errors',
|
|
27873
|
+
'telemetry_token',
|
|
27874
|
+
'telemetry_token_expires_at',
|
|
27875
|
+
'telemetry_url',
|
|
27876
|
+
],
|
|
27877
|
+
type: 'object',
|
|
27878
|
+
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
27879
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
27880
|
+
},
|
|
27881
|
+
ok: { type: 'boolean' },
|
|
27882
|
+
},
|
|
27883
|
+
required: ['bridge_client_session', 'ok'],
|
|
27884
|
+
type: 'object',
|
|
27885
|
+
},
|
|
27886
|
+
},
|
|
27887
|
+
},
|
|
27888
|
+
description: 'OK',
|
|
27889
|
+
},
|
|
27890
|
+
400: { description: 'Bad Request' },
|
|
27891
|
+
401: { description: 'Unauthorized' },
|
|
27892
|
+
},
|
|
27893
|
+
security: [{ bridge_client_session: [] }],
|
|
27894
|
+
summary:
|
|
27895
|
+
'/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token',
|
|
27896
|
+
tags: [],
|
|
27897
|
+
'x-fern-sdk-group-name': [
|
|
27898
|
+
'seam',
|
|
27899
|
+
'bridge',
|
|
27900
|
+
'v1',
|
|
27901
|
+
'bridge_client_sessions',
|
|
27902
|
+
],
|
|
27903
|
+
'x-fern-sdk-method-name': 'refresh_telemetry_token',
|
|
27904
|
+
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
27905
|
+
'x-response-key': 'bridge_client_session',
|
|
27906
|
+
'x-title': 'Refresh telemetry token for bridge client session',
|
|
27907
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
27908
|
+
},
|
|
27909
|
+
},
|
|
27642
27910
|
'/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
|
|
27643
27911
|
post: {
|
|
27644
27912
|
description:
|
|
@@ -27766,6 +28034,13 @@ export default {
|
|
|
27766
28034
|
},
|
|
27767
28035
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
27768
28036
|
tailscale_hostname: { type: 'string' },
|
|
28037
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
28038
|
+
telemetry_token_expires_at: {
|
|
28039
|
+
format: 'date-time',
|
|
28040
|
+
nullable: true,
|
|
28041
|
+
type: 'string',
|
|
28042
|
+
},
|
|
28043
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
27769
28044
|
},
|
|
27770
28045
|
required: [
|
|
27771
28046
|
'created_at',
|
|
@@ -27779,6 +28054,9 @@ export default {
|
|
|
27779
28054
|
'bridge_client_time_zone',
|
|
27780
28055
|
'bridge_client_machine_identifier_key',
|
|
27781
28056
|
'errors',
|
|
28057
|
+
'telemetry_token',
|
|
28058
|
+
'telemetry_token_expires_at',
|
|
28059
|
+
'telemetry_url',
|
|
27782
28060
|
],
|
|
27783
28061
|
type: 'object',
|
|
27784
28062
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|