Function getOpenapiSchema
- getOpenapiSchema(endpoint?): Promise<{
components: {
schemas: {
access_code: {
properties: {
access_code_id: {
description: string;
format: string;
type: string;
};
code: {
description: string;
nullable: boolean;
type: string;
};
common_code_key: {
description: string;
nullable: boolean;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
ends_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_backup: {
description: string;
type: string;
};
is_backup_access_code_available: {
description: string;
type: string;
};
is_external_modification_allowed: {
description: string;
type: string;
};
is_managed: {
description: string;
enum: boolean[];
type: string;
};
is_offline_access_code: {
description: string;
type: string;
};
is_one_time_use: {
description: string;
type: string;
};
is_scheduled_on_device: {
description: string;
type: string;
};
is_waiting_for_code_assignment: {
description: string;
type: string;
};
name: {
description: string;
nullable: boolean;
type: string;
};
pulled_backup_access_code_id: {
description: string;
format: string;
nullable: boolean;
type: string;
};
starts_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
status: {
description: string;
enum: string[];
type: string;
};
type: {
description: string;
enum: string[];
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
acs_access_group: {
description: string;
properties: {
access_group_type: {
deprecated: boolean;
enum: string[];
type: string;
x-deprecated: string;
};
access_group_type_display_name: {
deprecated: boolean;
type: string;
x-deprecated: string;
};
acs_access_group_id: {
description: string;
format: string;
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
name: {
description: string;
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_credential: {
description: string;
properties: {
access_method: {
description: string;
enum: string[];
type: string;
};
acs_credential_id: {
description: string;
format: string;
type: string;
};
acs_credential_pool_id: {
format: string;
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
acs_user_id: {
description: string;
format: string;
type: string;
};
card_number: {
nullable: boolean;
type: string;
};
code: {
description: string;
nullable: boolean;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
description: string;
minLength: number;
type: string;
};
ends_at: {
description: string;
type: string;
};
errors: {
items: {
properties: {
error_code: {
type: string;
};
message: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
is_issued: {
type: string;
};
is_latest_desired_state_synced_with_provider: {
description: string;
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
is_multi_phone_sync_credential: {
description: string;
type: string;
};
issued_at: {
format: string;
nullable: boolean;
type: string;
};
latest_desired_state_synced_with_provider_at: {
description: string;
format: string;
type: string;
};
parent_acs_credential_id: {
description: string;
format: string;
type: string;
};
starts_at: {
description: string;
type: string;
};
visionline_metadata: {
description: string;
properties: {
auto_join: {
type: string;
};
card_function_type: {
enum: string[];
type: string;
};
card_id: {
type: string;
};
common_acs_entrance_ids: {
items: {
format: string;
type: string;
};
type: string;
};
credential_id: {
type: string;
};
guest_acs_entrance_ids: {
items: {
format: string;
type: string;
};
type: string;
};
is_valid: {
type: string;
};
joiner_acs_credential_ids: {
items: {
format: string;
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
warnings: {
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_credential_pool: {
properties: {
acs_credential_pool_id: {
format: string;
type: string;
};
acs_system_id: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
display_name: {
minLength: number;
type: string;
};
external_type: {
enum: string[];
type: string;
};
external_type_display_name: {
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_credential_provisioning_automation: {
properties: {
acs_credential_provisioning_automation_id: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
credential_manager_acs_system_id: {
format: string;
type: string;
};
user_identity_id: {
format: string;
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_entrance: {
description: string;
properties: {
acs_entrance_id: {
description: string;
format: string;
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
assa_abloy_vostio_metadata: {
properties: {
door_name: {
type: string;
};
door_number: {
format: string;
type: string;
};
door_type: {
enum: string[];
type: string;
};
pms_id: {
type: string;
};
stand_open: {
type: string;
};
};
required: string[];
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
description: string;
type: string;
};
dormakaba_community_metadata: {
properties: {
access_point_name: {
type: string;
};
};
required: string[];
type: string;
};
errors: {
items: {
properties: {
error_code: {
type: string;
};
message: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
latch_metadata: {
properties: {
accessibility_type: {
type: string;
};
door_name: {
type: string;
};
door_type: {
type: string;
};
is_connected: {
type: string;
};
};
required: string[];
type: string;
};
salto_ks_metadata: {
properties: {
battery_level: {
type: string;
};
door_name: {
type: string;
};
intrusion_alarm: {
type: string;
};
left_open_alarm: {
type: string;
};
lock_type: {
type: string;
};
locked_state: {
type: string;
};
online: {
type: string;
};
privacy_mode: {
type: string;
};
};
required: string[];
type: string;
};
visionline_metadata: {
properties: {
door_category: {
enum: string[];
type: string;
};
door_name: {
type: string;
};
profiles: {
items: {
properties: {
visionline_door_profile_id: ...;
visionline_door_profile_type: ...;
};
required: (...)[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
};
required: string[];
type: string;
};
acs_system: {
description: string;
properties: {
acs_system_id: {
description: string;
format: string;
type: string;
};
can_add_acs_users_to_acs_access_groups: {
description: string;
type: string;
};
can_automate_enrollment: {
description: string;
type: string;
};
can_create_acs_access_groups: {
description: string;
type: string;
};
can_remove_acs_users_from_acs_access_groups: {
description: string;
type: string;
};
connected_account_ids: {
description: string;
items: {
format: string;
type: string;
};
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
default_credential_manager_acs_system_id: {
description: string;
format: string;
nullable: boolean;
type: string;
x-draft: string;
};
errors: {
description: string;
items: {
description: string;
oneOf: {
description: string;
properties: {
created_at: ...;
error_code: ...;
message: ...;
};
required: (...)[];
type: string;
}[];
};
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
image_alt_text: {
description: string;
type: string;
};
image_url: {
description: string;
type: string;
};
is_credential_manager: {
description: string;
type: string;
};
location: {
properties: {
time_zone: {
description: string;
nullable: boolean;
type: string;
};
};
required: string[];
type: string;
};
name: {
description: string;
type: string;
};
system_type: {
deprecated: boolean;
enum: string[];
type: string;
x-deprecated: string;
};
system_type_display_name: {
deprecated: boolean;
type: string;
x-deprecated: string;
};
visionline_metadata: {
properties: {
lan_address: {
description: string;
type: string;
};
mobile_access_uuid: {
description: string;
type: string;
};
system_id: {
description: string;
type: string;
};
};
required: string[];
type: string;
};
warnings: {
description: string;
items: {
description: string;
properties: {
created_at: {
description: string;
format: string;
type: string;
};
message: {
description: string;
type: string;
};
warning_code: {
description: string;
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_user: {
properties: {
access_schedule: {
description: string;
properties: {
ends_at: {
description: string;
format: string;
type: string;
};
starts_at: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
acs_user_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
description: string;
type: string;
};
email: {
deprecated: boolean;
format: string;
type: string;
x-deprecated: string;
};
email_address: {
description: string;
format: string;
type: string;
};
errors: {
description: string;
items: {
description: string;
oneOf: {
description: string;
properties: {
created_at: ...;
error_code: ...;
message: ...;
};
required: (...)[];
type: string;
}[];
};
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
full_name: {
description: string;
type: string;
};
hid_acs_system_id: {
format: string;
type: string;
};
is_latest_desired_state_synced_with_provider: {
type: string;
x-undocumented: string;
};
is_managed: {
enum: boolean[];
type: string;
};
is_suspended: {
description: string;
type: string;
};
latest_desired_state_synced_with_provider_at: {
format: string;
type: string;
x-undocumented: string;
};
phone_number: {
description: string;
type: string;
};
user_identity_email_address: {
description: string;
nullable: boolean;
type: string;
};
user_identity_full_name: {
description: string;
nullable: boolean;
type: string;
};
user_identity_id: {
description: string;
type: string;
};
user_identity_phone_number: {
description: string;
nullable: boolean;
type: string;
};
warnings: {
description: string;
items: {
description: string;
oneOf: {
description: string;
properties: {
created_at: ...;
message: ...;
warning_code: ...;
};
required: (...)[];
type: string;
}[];
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
action_attempt: {
oneOf: (
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold?: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable?: undefined;
oneOf?: undefined;
properties: {
message: ...;
type: ...;
};
required: (...)[];
type: string;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder: ...;
acs_credential_on_seam: ...;
noise_threshold?: ...;
warnings: ...;
};
required: (...)[];
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable?: undefined;
oneOf: (...)[];
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description: string;
nullable?: undefined;
oneOf: (...)[];
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold?: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable?: undefined;
oneOf?: undefined;
properties: {
message: ...;
type: ...;
};
required: (...)[];
type: string;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold?: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
})[];
};
client_session: {
properties: {
client_session_id: {
format: string;
type: string;
};
connect_webview_ids: {
items: {
format: string;
type: string;
};
type: string;
};
connected_account_ids: {
items: {
format: string;
type: string;
};
type: string;
};
created_at: {
format: string;
type: string;
};
device_count: {
format: string;
type: string;
};
token: {
type: string;
};
user_identifier_key: {
nullable: boolean;
type: string;
};
user_identity_ids: {
items: {
format: string;
type: string;
};
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
connect_webview: {
properties: {
accepted_devices: {
deprecated: boolean;
items: {
type: string;
};
type: string;
x-deprecated: string;
};
accepted_providers: {
items: {
type: string;
};
type: string;
};
any_device_allowed: {
deprecated: boolean;
type: string;
x-deprecated: string;
};
any_provider_allowed: {
type: string;
};
authorized_at: {
format: string;
nullable: boolean;
type: string;
};
automatically_manage_new_devices: {
type: string;
};
connect_webview_id: {
format: string;
type: string;
};
connected_account_id: {
format: string;
nullable: boolean;
type: string;
};
created_at: {
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
custom_redirect_failure_url: {
format: string;
nullable: boolean;
type: string;
};
custom_redirect_url: {
format: string;
nullable: boolean;
type: string;
};
device_selection_mode: {
enum: string[];
type: string;
};
login_successful: {
type: string;
};
selected_provider: {
nullable: boolean;
type: string;
};
status: {
enum: string[];
type: string;
};
url: {
format: string;
type: string;
};
wait_for_device_creation: {
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
connected_account: {
properties: {
account_type: {
type: string;
};
account_type_display_name: {
type: string;
};
automatically_manage_new_devices: {
type: string;
};
connected_account_id: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
errors: {
items: {
properties: {
error_code: {
type: string;
};
is_connected_account_error: {
enum: (...)[];
type: string;
};
message: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
user_identifier: {
properties: {
api_url: {
type: string;
};
email: {
type: string;
};
exclusive: {
type: string;
};
phone: {
type: string;
};
username: {
type: string;
};
};
type: string;
};
warnings: {
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
device: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
capabilities_supported: {
description: string;
items: {
enum: string[];
type: string;
};
type: string;
};
connected_account_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
device_type: {
description: string;
oneOf: {
enum: string[];
type: string;
}[];
};
display_name: {
description: string;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
description: string;
enum: boolean[];
type: string;
};
location: {
description: string;
nullable: boolean;
properties: {
location_name: {
description: string;
type: string;
};
timezone: {
description: string;
type: string;
};
};
type: string;
};
nickname: {
description: string;
type: string;
};
properties: {
allOf: ({
allOf: (...)[];
} | {
allOf: (...)[];
})[];
description: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
device_provider: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
device_provider_name: {
enum: string[];
type: string;
};
display_name: {
type: string;
};
image_url: {
type: string;
};
provider_categories: {
items: {
enum: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
enrollment_automation: {
description: string;
properties: {
created_at: {
description: string;
format: string;
type: string;
};
credential_manager_acs_system_id: {
description: string;
format: string;
type: string;
};
enrollment_automation_id: {
description: string;
format: string;
type: string;
};
user_identity_id: {
description: string;
format: string;
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
event: {
properties: {
acs_credential_id: {
format: string;
type: string;
};
acs_system_id: {
format: string;
type: string;
};
acs_user_id: {
format: string;
type: string;
};
action_attempt_id: {
format: string;
type: string;
};
client_session_id: {
format: string;
type: string;
};
climate_preset_key: {
type: string;
};
cooling_set_point_celsius: {
format: string;
type: string;
};
cooling_set_point_fahrenheit: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
device_id: {
format: string;
type: string;
};
enrollment_automation_id: {
format: string;
type: string;
};
event_description: {
type: string;
};
event_id: {
format: string;
type: string;
};
event_type: {
type: string;
};
fan_mode_setting: {
type: string;
};
heating_set_point_celsius: {
format: string;
type: string;
};
heating_set_point_fahrenheit: {
format: string;
type: string;
};
hvac_mode_setting: {
type: string;
};
is_fallback_climate_preset: {
type: string;
};
method: {
type: string;
};
occurred_at: {
format: string;
type: string;
};
thermostat_schedule_id: {
format: string;
nullable: boolean;
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
network: {
properties: {
created_at: {
format: string;
type: string;
};
display_name: {
type: string;
};
network_id: {
format: string;
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
noise_threshold: {
properties: {
device_id: {
format: string;
type: string;
};
ends_daily_at: {
type: string;
};
name: {
type: string;
};
noise_threshold_decibels: {
format: string;
type: string;
};
noise_threshold_id: {
format: string;
type: string;
};
noise_threshold_nrs: {
format: string;
type: string;
};
starts_daily_at: {
type: string;
};
};
required: string[];
type: string;
};
phone: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
capabilities_supported: {
description: string;
items: {
enum: string[];
type: string;
};
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
device_type: {
enum: string[];
type: string;
};
display_name: {
description: string;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
description: string;
enum: boolean[];
type: string;
};
location: {
description: string;
nullable: boolean;
properties: {
location_name: {
description: string;
type: string;
};
timezone: {
description: string;
type: string;
};
};
type: string;
};
nickname: {
description: string;
type: string;
};
properties: {
properties: {
assa_abloy_credential_service_metadata: {
properties: {
endpoints: {
items: ...;
type: ...;
};
has_active_endpoint: {
type: ...;
};
};
required: string[];
type: string;
};
};
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
service_health: {
properties: {
description: {
type: string;
};
service: {
type: string;
};
status: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
thermostat_schedule: {
description: string;
properties: {
climate_preset_key: {
description: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
ends_at: {
description: string;
format: string;
type: string;
};
errors: {
description: string;
};
max_override_period_minutes: {
description: string;
minimum: number;
type: string;
};
name: {
description: string;
type: string;
};
starts_at: {
description: string;
format: string;
type: string;
};
thermostat_schedule_id: {
description: string;
format: string;
type: string;
};
unstable_is_override_allowed: {
description: string;
type: string;
x-undocumented: string;
};
};
required: string[];
type: string;
};
unmanaged_access_code: {
properties: {
access_code_id: {
description: string;
format: string;
type: string;
};
code: {
description: string;
nullable: boolean;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
ends_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
name: {
description: string;
nullable: boolean;
type: string;
};
starts_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
status: {
enum: string[];
type: string;
};
type: {
description: string;
enum: string[];
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
unmanaged_device: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
capabilities_supported: {
description: string;
items: {
enum: string[];
type: string;
};
type: string;
};
connected_account_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
device_type: {
description: string;
oneOf: {
enum: string[];
type: string;
}[];
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
location: {
description: string;
nullable: boolean;
properties: {
location_name: {
description: string;
type: string;
};
timezone: {
description: string;
type: string;
};
};
type: string;
};
properties: {
properties: {
accessory_keypad: {
description: string;
properties: {
battery: {
description: ...;
properties: ...;
required: ...;
type: ...;
};
is_connected: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
battery: {
description: string;
properties: {
level: {
format: ...;
maximum: ...;
minimum: ...;
type: ...;
};
status: {
enum: ...;
type: ...;
};
};
required: string[];
type: string;
};
battery_level: {
description: string;
format: string;
maximum: number;
minimum: number;
type: string;
};
image_alt_text: {
description: string;
type: string;
};
image_url: {
description: string;
format: string;
type: string;
};
manufacturer: {
description: string;
type: string;
};
model: {
properties: {
accessory_keypad_supported: {
deprecated: ...;
type: ...;
x-deprecated: ...;
};
can_connect_accessory_keypad: {
description: ...;
type: ...;
};
display_name: {
description: ...;
type: ...;
};
has_built_in_keypad: {
description: ...;
type: ...;
};
manufacturer_display_name: {
description: ...;
type: ...;
};
offline_access_codes_supported: {
description: ...;
type: ...;
};
online_access_codes_supported: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
name: {
deprecated: boolean;
description: string;
type: string;
x-deprecated: string;
};
offline_access_codes_enabled: {
description: string;
type: string;
};
online: {
description: string;
type: string;
};
online_access_codes_enabled: {
description: string;
type: string;
};
};
required: string[];
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
user_identity: {
description: string;
properties: {
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
minLength: number;
type: string;
};
email_address: {
description: string;
format: string;
nullable: boolean;
type: string;
};
full_name: {
minLength: number;
nullable: boolean;
type: string;
};
phone_number: {
description: string;
nullable: boolean;
type: string;
};
user_identity_id: {
description: string;
format: string;
type: string;
};
user_identity_key: {
description: string;
minLength: number;
nullable: boolean;
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
webhook: {
properties: {
event_types: {
items: {
type: string;
};
type: string;
};
secret: {
type: string;
};
url: {
type: string;
};
webhook_id: {
type: string;
};
};
required: string[];
type: string;
};
workspace: {
properties: {
company_name: {
type: string;
};
connect_partner_name: {
deprecated: boolean;
nullable: boolean;
type: string;
x-deprecated: string;
};
is_sandbox: {
type: string;
};
name: {
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
};
securitySchemes: {
access_token: {
bearerFormat: string;
scheme: string;
type: string;
};
api_key: {
bearerFormat: string;
scheme: string;
type: string;
};
client_session: {
bearerFormat: string;
scheme: string;
type: string;
};
client_session_token: {
in: string;
name: string;
type: string;
};
console_session: {
bearerFormat: string;
scheme: string;
type: string;
};
pat_with_workspace: {
bearerFormat: string;
scheme: string;
type: string;
};
pat_without_workspace: {
bearerFormat: string;
scheme: string;
type: string;
};
seam_client_session_token: {
in: string;
name: string;
type: string;
};
seam_workspace: {
in: string;
name: string;
type: string;
};
user_session: {
bearerFormat: string;
scheme: string;
type: string;
};
user_session_without_workspace: {
bearerFormat: string;
scheme: string;
type: string;
};
};
};
info: {
title: string;
version: string;
};
openapi: string;
paths: {
/access_codes/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
common_code_key: {
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/create_multiple: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
behavior_when_code_cannot_be_shared: {
default: ...;
enum: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_ids: {
items: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
behavior_when_code_cannot_be_shared: {
default: ...;
enum: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_ids: {
items: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
};
/access_codes/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/generate_code: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
generated_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
code: {
type: ...;
};
device_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
access_token?: undefined;
api_key: never[];
client_session?: undefined;
user_session?: undefined;
}
| {
access_token: never[];
api_key?: undefined;
client_session?: undefined;
user_session?: undefined;
}
| {
access_token?: undefined;
api_key?: undefined;
client_session?: undefined;
user_session: never[];
}
| {
access_token?: undefined;
api_key?: undefined;
client_session: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_ids: {
items: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/pull_backup_access_code: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
backup_access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/simulate/create_unmanaged_access_code: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/unmanaged/convert_to_managed: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/unmanaged/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/unmanaged/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
code: {
type: ...;
};
device_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/unmanaged/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/unmanaged/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
type: {
enum: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
type: {
enum: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
type: {
enum: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
};
/access_codes/update_multiple: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
common_code_key: {
type: ...;
};
ends_at: {
type: ...;
};
name: {
type: ...;
};
starts_at: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
common_code_key: {
type: ...;
};
ends_at: {
type: ...;
};
name: {
type: ...;
};
starts_at: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
};
};
/acs/access_groups/add_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/acs/access_groups/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_group: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_groups: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/list_accessible_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/list_users: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/remove_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/access_groups/unmanaged/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_group: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/access_groups/unmanaged/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_groups: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/credential_pools/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential_pools: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/credential_provisioning_automations/launch: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_pool_id: {
format: ...;
type: ...;
};
create_credential_manager_user: {
type: ...;
};
credential_manager_acs_system_id: {
format: ...;
type: ...;
};
credential_manager_acs_user_id: {
format: ...;
type: ...;
};
user_identity_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential_provisioning_automation: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/credentials/assign: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/credentials/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_method: {
description: ...;
enum: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
allowed_acs_entrance_ids: {
default: ...;
description: ...;
items: ...;
type: ...;
};
assa_abloy_vostio_metadata: {
description: ...;
properties: ...;
type: ...;
};
code: {
description: ...;
pattern: ...;
type: ...;
};
credential_manager_acs_system_id: {
description: ...;
format: ...;
type: ...;
};
ends_at: {
description: ...;
format: ...;
type: ...;
};
is_multi_phone_sync_credential: {
default: ...;
description: ...;
type: ...;
};
starts_at: {
description: ...;
format: ...;
type: ...;
};
visionline_metadata: {
description: ...;
properties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/credentials/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
allOf: ((...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credentials: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/list_accessible_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/unassign: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/credentials/unmanaged/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
x-undocumented: string;
};
};
/acs/credentials/unmanaged/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: (
| (...)
| (...)
| (...)
| (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credentials: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
x-undocumented: string;
};
};
/acs/credentials/update: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
type: ...;
};
code: {
description: ...;
pattern: ...;
type: ...;
};
ends_at: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
type: ...;
};
code: {
description: ...;
pattern: ...;
type: ...;
};
ends_at: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/encoders/encode_credential: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_encoder_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/encoders/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: ((...) | (...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_encoders: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/encoders/scan_credential: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_encoder_id: {
description: ...;
format: ...;
type: ...;
};
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/entrances/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_entrance_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrance: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
access_token?: undefined;
api_key: never[];
client_session?: undefined;
user_session?: undefined;
}
| {
access_token: never[];
api_key?: undefined;
client_session?: undefined;
user_session?: undefined;
}
| {
access_token?: undefined;
api_key?: undefined;
client_session?: undefined;
user_session: never[];
}
| {
access_token?: undefined;
api_key?: undefined;
client_session: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/entrances/grant_access: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_entrance_id: {
format: ...;
type: ...;
};
acs_user_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/entrances/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
format: ...;
type: ...;
};
acs_system_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/entrances/list_credentials_with_access: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_entrance_id: {
format: ...;
type: ...;
};
include_if: {
items: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credentials: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/systems/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_system: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/systems/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_systems: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/systems/list_compatible_credential_manager_acs_systems: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_systems: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/add_to_access_group: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/acs/users/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_schedule: {
description: ...;
properties: ...;
required: ...;
type: ...;
};
acs_access_group_ids: {
default: ...;
description: ...;
items: ...;
type: ...;
};
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
email: {
deprecated: ...;
format: ...;
type: ...;
x-deprecated: ...;
};
email_address: {
description: ...;
format: ...;
type: ...;
};
full_name: {
description: ...;
type: ...;
};
phone_number: {
description: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_user: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_user: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
created_before: {
format: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
user_identity_email_address: {
description: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_phone_number: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/list_accessible_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/remove_from_access_group: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/revoke_access_to_all_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/suspend: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/unmanaged/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_user: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/users/unmanaged/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
format: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
user_identity_email_address: {
type: ...;
};
user_identity_id: {
format: ...;
type: ...;
};
user_identity_phone_number: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/users/unsuspend: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/update: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_schedule: {
description: ...;
nullable: ...;
properties: ...;
required: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
email: {
deprecated: ...;
format: ...;
type: ...;
x-deprecated: ...;
};
email_address: {
description: ...;
format: ...;
type: ...;
};
full_name: {
description: ...;
type: ...;
};
hid_acs_system_id: {
format: ...;
type: ...;
};
phone_number: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_schedule: {
description: ...;
nullable: ...;
properties: ...;
required: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
email: {
deprecated: ...;
format: ...;
type: ...;
x-deprecated: ...;
};
email_address: {
description: ...;
format: ...;
type: ...;
};
full_name: {
description: ...;
type: ...;
};
hid_acs_system_id: {
format: ...;
type: ...;
};
phone_number: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/action_attempts/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
action_attempt_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/action_attempts/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
action_attempt_ids: {
items: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempts: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/client_sessions/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
};
/client_sessions/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/client_sessions/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
user_identifier_key: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/client_sessions/get_or_create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
};
/client_sessions/grant_access: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/client_sessions/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
connect_webview_id: {
type: ...;
};
user_identifier_key: {
type: ...;
};
user_identity_id: {
type: ...;
};
without_user_identifier_key: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_sessions: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/client_sessions/revoke: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/connect_webviews/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
accepted_providers: {
items: ...;
type: ...;
};
automatically_manage_new_devices: {
default: ...;
type: ...;
};
custom_metadata: {
additionalProperties: ...;
type: ...;
};
custom_redirect_failure_url: {
type: ...;
};
custom_redirect_url: {
type: ...;
};
device_selection_mode: {
enum: ...;
type: ...;
};
provider_category: {
enum: ...;
type: ...;
};
wait_for_device_creation: {
default: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connect_webview: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connect_webviews/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/connect_webviews/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connect_webview: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connect_webviews/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connect_webviews: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connected_accounts/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connected_account_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/connected_accounts/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: ((...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connected_account: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connected_accounts/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connected_accounts: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connected_accounts/update: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
automatically_manage_new_devices: {
type: ...;
};
connected_account_id: {
format: ...;
type: ...;
};
custom_metadata: {
additionalProperties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connected_account: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/devices/list_device_providers: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
provider_category: {
enum: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device_providers: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/simulate/connect: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/simulate/disconnect: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/simulate/remove: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/unmanaged/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/unmanaged/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/unmanaged/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
is_managed: {
enum: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
is_managed: {
enum: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata: {
additionalProperties: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
is_managed: {
default: ...;
type: ...;
};
name: {
nullable: ...;
type: ...;
};
properties: {
properties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata: {
additionalProperties: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
is_managed: {
default: ...;
type: ...;
};
name: {
nullable: ...;
type: ...;
};
properties: {
properties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/events/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
event_id: {
format: ...;
type: ...;
};
event_type: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
event: ...;
message: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/events/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
access_code_ids: {
items: ...;
type: ...;
};
acs_system_id: {
format: ...;
type: ...;
};
acs_system_ids: {
items: ...;
type: ...;
};
between: {
items: ...;
maxItems: ...;
minItems: ...;
type: ...;
};
connect_webview_id: {
format: ...;
type: ...;
};
connected_account_id: {
format: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
device_ids: {
items: ...;
type: ...;
};
event_type: {
enum: ...;
type: ...;
};
event_types: {
items: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
since: {
type: ...;
};
unstable_offset: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
events: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device: ...;
lock: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
locks: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/lock_door: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/unlock_door: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/networks/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
network_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
network: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/networks/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
networks: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
noise_sensors: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
noise_threshold: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/noise_sensors/noise_thresholds/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
noise_threshold_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
noise_threshold: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
is_programmed: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
noise_thresholds: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
};
/noise_sensors/simulate/trigger_noise_threshold: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/phones/deactivate: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/phones/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
format: ...;
type: ...;
};
owner_user_identity_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
phones: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/phones/simulate/create_sandbox_phone: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
assa_abloy_metadata: {
default: ...;
properties: ...;
type: ...;
};
custom_sdk_installation_id: {
type: ...;
};
phone_metadata: {
default: ...;
properties: ...;
type: ...;
};
user_identity_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
phone: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/thermostats/activate_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/cool: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/create_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
hvac_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
manual_override_allowed: {
default: ...;
type: ...;
};
name: {
default: ...;
description: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/delete_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
x-undocumented: string;
};
};
/thermostats/heat: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/heat_cool: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
ok: ...;
thermostats: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/off: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
type: ...;
};
ends_at: {
description: ...;
type: ...;
};
is_override_allowed: {
default: ...;
type: ...;
};
max_override_period_minutes: {
default: ...;
description: ...;
minimum: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
starts_at: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat_schedule: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/schedules/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat_schedule: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat_schedules: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/update: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
ends_at: {
description: ...;
type: ...;
};
is_override_allowed: {
type: ...;
};
max_override_period_minutes: {
description: ...;
minimum: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
starts_at: {
description: ...;
type: ...;
};
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
ends_at: {
description: ...;
type: ...;
};
is_override_allowed: {
type: ...;
};
max_override_period_minutes: {
description: ...;
minimum: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
starts_at: {
description: ...;
type: ...;
};
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/set_fallback_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/set_fan_mode: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
fan_mode: {
deprecated: ...;
enum: ...;
type: ...;
x-deprecated: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/set_temperature_threshold: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
lower_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
lower_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
lower_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
lower_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/update_climate_preset: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
hvac_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
manual_override_allowed: {
deprecated: ...;
description: ...;
type: ...;
x-deprecated: ...;
};
name: {
default: ...;
description: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
hvac_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
manual_override_allowed: {
deprecated: ...;
description: ...;
type: ...;
x-deprecated: ...;
};
name: {
default: ...;
description: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/add_acs_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/user_identities/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
email_address: {
description: ...;
format: ...;
nullable: ...;
type: ...;
};
full_name: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
phone_number: {
description: ...;
nullable: ...;
type: ...;
};
user_identity_key: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
user_identity: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/enrollment_automations/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/enrollment_automations/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/enrollment_automations/launch: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_pool_id: {
description: ...;
format: ...;
type: ...;
};
create_credential_manager_user: {
description: ...;
type: ...;
};
credential_manager_acs_system_id: {
description: ...;
format: ...;
type: ...;
};
credential_manager_acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/enrollment_automations/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
enrollment_automations: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: ((...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
user_identity: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/grant_access_to_device: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/user_identities/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
credential_manager_acs_system_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
user_identities: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/list_accessible_devices: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
accessible_devices: ...;
devices: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/list_acs_systems: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_systems: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/list_acs_users: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/remove_acs_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/revoke_access_to_device: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
email_address: {
description: ...;
format: ...;
nullable: ...;
type: ...;
};
full_name: {
minLength: ...;
nullable: ...;
type: ...;
};
phone_number: {
description: ...;
nullable: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_key: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
email_address: {
description: ...;
format: ...;
nullable: ...;
type: ...;
};
full_name: {
minLength: ...;
nullable: ...;
type: ...;
};
phone_number: {
description: ...;
nullable: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_key: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/webhooks/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
event_types: {
default: ...;
items: ...;
type: ...;
};
url: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhook: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/webhooks/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/webhooks/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhook: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/webhooks/list: {
get: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhooks: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhooks: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/webhooks/update: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
event_types: {
items: ...;
type: ...;
};
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
event_types: {
items: ...;
type: ...;
};
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
};
/workspaces/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
company_name: {
type: ...;
};
connect_partner_name: {
deprecated: ...;
nullable: ...;
type: ...;
x-deprecated: ...;
};
is_sandbox: {
default: ...;
type: ...;
};
name: {
type: ...;
};
webview_logo_shape: {
enum: ...;
type: ...;
};
webview_primary_button_color: {
type: ...;
};
webview_primary_button_text_color: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspace: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: {
pat_without_workspace: never[];
}[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/workspaces/get: {
get: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspace: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
user_session: never[];
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspace: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
user_session: never[];
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/workspaces/list: {
get: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspaces: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace: never[];
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session: never[];
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace: never[];
}
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspaces: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace: never[];
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session: never[];
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace: never[];
}
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/workspaces/reset_sandbox: {
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
};
servers: {
url: string;
}[];
tags: {
description: string;
name: string;
}[];
}> Parameters
- endpoint: string = defaultEndpoint
Returns Promise<{
components: {
schemas: {
access_code: {
properties: {
access_code_id: {
description: string;
format: string;
type: string;
};
code: {
description: string;
nullable: boolean;
type: string;
};
common_code_key: {
description: string;
nullable: boolean;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
ends_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_backup: {
description: string;
type: string;
};
is_backup_access_code_available: {
description: string;
type: string;
};
is_external_modification_allowed: {
description: string;
type: string;
};
is_managed: {
description: string;
enum: boolean[];
type: string;
};
is_offline_access_code: {
description: string;
type: string;
};
is_one_time_use: {
description: string;
type: string;
};
is_scheduled_on_device: {
description: string;
type: string;
};
is_waiting_for_code_assignment: {
description: string;
type: string;
};
name: {
description: string;
nullable: boolean;
type: string;
};
pulled_backup_access_code_id: {
description: string;
format: string;
nullable: boolean;
type: string;
};
starts_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
status: {
description: string;
enum: string[];
type: string;
};
type: {
description: string;
enum: string[];
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
acs_access_group: {
description: string;
properties: {
access_group_type: {
deprecated: boolean;
enum: string[];
type: string;
x-deprecated: string;
};
access_group_type_display_name: {
deprecated: boolean;
type: string;
x-deprecated: string;
};
acs_access_group_id: {
description: string;
format: string;
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
name: {
description: string;
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_credential: {
description: string;
properties: {
access_method: {
description: string;
enum: string[];
type: string;
};
acs_credential_id: {
description: string;
format: string;
type: string;
};
acs_credential_pool_id: {
format: string;
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
acs_user_id: {
description: string;
format: string;
type: string;
};
card_number: {
nullable: boolean;
type: string;
};
code: {
description: string;
nullable: boolean;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
description: string;
minLength: number;
type: string;
};
ends_at: {
description: string;
type: string;
};
errors: {
items: {
properties: {
error_code: {
type: string;
};
message: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
is_issued: {
type: string;
};
is_latest_desired_state_synced_with_provider: {
description: string;
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
is_multi_phone_sync_credential: {
description: string;
type: string;
};
issued_at: {
format: string;
nullable: boolean;
type: string;
};
latest_desired_state_synced_with_provider_at: {
description: string;
format: string;
type: string;
};
parent_acs_credential_id: {
description: string;
format: string;
type: string;
};
starts_at: {
description: string;
type: string;
};
visionline_metadata: {
description: string;
properties: {
auto_join: {
type: string;
};
card_function_type: {
enum: string[];
type: string;
};
card_id: {
type: string;
};
common_acs_entrance_ids: {
items: {
format: string;
type: string;
};
type: string;
};
credential_id: {
type: string;
};
guest_acs_entrance_ids: {
items: {
format: string;
type: string;
};
type: string;
};
is_valid: {
type: string;
};
joiner_acs_credential_ids: {
items: {
format: string;
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
warnings: {
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_credential_pool: {
properties: {
acs_credential_pool_id: {
format: string;
type: string;
};
acs_system_id: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
display_name: {
minLength: number;
type: string;
};
external_type: {
enum: string[];
type: string;
};
external_type_display_name: {
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_credential_provisioning_automation: {
properties: {
acs_credential_provisioning_automation_id: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
credential_manager_acs_system_id: {
format: string;
type: string;
};
user_identity_id: {
format: string;
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_entrance: {
description: string;
properties: {
acs_entrance_id: {
description: string;
format: string;
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
assa_abloy_vostio_metadata: {
properties: {
door_name: {
type: string;
};
door_number: {
format: string;
type: string;
};
door_type: {
enum: string[];
type: string;
};
pms_id: {
type: string;
};
stand_open: {
type: string;
};
};
required: string[];
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
description: string;
type: string;
};
dormakaba_community_metadata: {
properties: {
access_point_name: {
type: string;
};
};
required: string[];
type: string;
};
errors: {
items: {
properties: {
error_code: {
type: string;
};
message: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
latch_metadata: {
properties: {
accessibility_type: {
type: string;
};
door_name: {
type: string;
};
door_type: {
type: string;
};
is_connected: {
type: string;
};
};
required: string[];
type: string;
};
salto_ks_metadata: {
properties: {
battery_level: {
type: string;
};
door_name: {
type: string;
};
intrusion_alarm: {
type: string;
};
left_open_alarm: {
type: string;
};
lock_type: {
type: string;
};
locked_state: {
type: string;
};
online: {
type: string;
};
privacy_mode: {
type: string;
};
};
required: string[];
type: string;
};
visionline_metadata: {
properties: {
door_category: {
enum: string[];
type: string;
};
door_name: {
type: string;
};
profiles: {
items: {
properties: {
visionline_door_profile_id: ...;
visionline_door_profile_type: ...;
};
required: (...)[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
};
required: string[];
type: string;
};
acs_system: {
description: string;
properties: {
acs_system_id: {
description: string;
format: string;
type: string;
};
can_add_acs_users_to_acs_access_groups: {
description: string;
type: string;
};
can_automate_enrollment: {
description: string;
type: string;
};
can_create_acs_access_groups: {
description: string;
type: string;
};
can_remove_acs_users_from_acs_access_groups: {
description: string;
type: string;
};
connected_account_ids: {
description: string;
items: {
format: string;
type: string;
};
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
default_credential_manager_acs_system_id: {
description: string;
format: string;
nullable: boolean;
type: string;
x-draft: string;
};
errors: {
description: string;
items: {
description: string;
oneOf: {
description: string;
properties: {
created_at: ...;
error_code: ...;
message: ...;
};
required: (...)[];
type: string;
}[];
};
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
image_alt_text: {
description: string;
type: string;
};
image_url: {
description: string;
type: string;
};
is_credential_manager: {
description: string;
type: string;
};
location: {
properties: {
time_zone: {
description: string;
nullable: boolean;
type: string;
};
};
required: string[];
type: string;
};
name: {
description: string;
type: string;
};
system_type: {
deprecated: boolean;
enum: string[];
type: string;
x-deprecated: string;
};
system_type_display_name: {
deprecated: boolean;
type: string;
x-deprecated: string;
};
visionline_metadata: {
properties: {
lan_address: {
description: string;
type: string;
};
mobile_access_uuid: {
description: string;
type: string;
};
system_id: {
description: string;
type: string;
};
};
required: string[];
type: string;
};
warnings: {
description: string;
items: {
description: string;
properties: {
created_at: {
description: string;
format: string;
type: string;
};
message: {
description: string;
type: string;
};
warning_code: {
description: string;
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_user: {
properties: {
access_schedule: {
description: string;
properties: {
ends_at: {
description: string;
format: string;
type: string;
};
starts_at: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
acs_system_id: {
description: string;
format: string;
type: string;
};
acs_user_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
description: string;
type: string;
};
email: {
deprecated: boolean;
format: string;
type: string;
x-deprecated: string;
};
email_address: {
description: string;
format: string;
type: string;
};
errors: {
description: string;
items: {
description: string;
oneOf: {
description: string;
properties: {
created_at: ...;
error_code: ...;
message: ...;
};
required: (...)[];
type: string;
}[];
};
type: string;
};
external_type: {
description: string;
enum: string[];
type: string;
};
external_type_display_name: {
description: string;
type: string;
};
full_name: {
description: string;
type: string;
};
hid_acs_system_id: {
format: string;
type: string;
};
is_latest_desired_state_synced_with_provider: {
type: string;
x-undocumented: string;
};
is_managed: {
enum: boolean[];
type: string;
};
is_suspended: {
description: string;
type: string;
};
latest_desired_state_synced_with_provider_at: {
format: string;
type: string;
x-undocumented: string;
};
phone_number: {
description: string;
type: string;
};
user_identity_email_address: {
description: string;
nullable: boolean;
type: string;
};
user_identity_full_name: {
description: string;
nullable: boolean;
type: string;
};
user_identity_id: {
description: string;
type: string;
};
user_identity_phone_number: {
description: string;
nullable: boolean;
type: string;
};
warnings: {
description: string;
items: {
description: string;
oneOf: {
description: string;
properties: {
created_at: ...;
message: ...;
warning_code: ...;
};
required: (...)[];
type: string;
}[];
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
action_attempt: {
oneOf: (
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold?: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable?: undefined;
oneOf?: undefined;
properties: {
message: ...;
type: ...;
};
required: (...)[];
type: string;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder: ...;
acs_credential_on_seam: ...;
noise_threshold?: ...;
warnings: ...;
};
required: (...)[];
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable?: undefined;
oneOf: (...)[];
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description: string;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description: string;
nullable?: undefined;
oneOf: (...)[];
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold?: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable?: undefined;
oneOf?: undefined;
properties: {
message: ...;
type: ...;
};
required: (...)[];
type: string;
};
result: {
description?: undefined;
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold?: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
}
| {
description?: undefined;
properties: {
action_attempt_id: {
description: string;
format: string;
type: string;
x-title: string;
};
action_type: {
enum: (...)[];
type: string;
};
error: {
nullable: boolean;
oneOf?: undefined;
properties?: undefined;
required?: undefined;
type?: undefined;
};
result: {
description?: undefined;
nullable?: undefined;
oneOf?: undefined;
properties: {
access_code?: ...;
acs_credential_on_encoder?: ...;
acs_credential_on_seam?: ...;
noise_threshold: ...;
warnings?: ...;
};
required?: undefined;
type: string;
};
status: {
enum: (...)[];
type: string;
};
};
required: string[];
type: string;
})[];
};
client_session: {
properties: {
client_session_id: {
format: string;
type: string;
};
connect_webview_ids: {
items: {
format: string;
type: string;
};
type: string;
};
connected_account_ids: {
items: {
format: string;
type: string;
};
type: string;
};
created_at: {
format: string;
type: string;
};
device_count: {
format: string;
type: string;
};
token: {
type: string;
};
user_identifier_key: {
nullable: boolean;
type: string;
};
user_identity_ids: {
items: {
format: string;
type: string;
};
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
connect_webview: {
properties: {
accepted_devices: {
deprecated: boolean;
items: {
type: string;
};
type: string;
x-deprecated: string;
};
accepted_providers: {
items: {
type: string;
};
type: string;
};
any_device_allowed: {
deprecated: boolean;
type: string;
x-deprecated: string;
};
any_provider_allowed: {
type: string;
};
authorized_at: {
format: string;
nullable: boolean;
type: string;
};
automatically_manage_new_devices: {
type: string;
};
connect_webview_id: {
format: string;
type: string;
};
connected_account_id: {
format: string;
nullable: boolean;
type: string;
};
created_at: {
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
custom_redirect_failure_url: {
format: string;
nullable: boolean;
type: string;
};
custom_redirect_url: {
format: string;
nullable: boolean;
type: string;
};
device_selection_mode: {
enum: string[];
type: string;
};
login_successful: {
type: string;
};
selected_provider: {
nullable: boolean;
type: string;
};
status: {
enum: string[];
type: string;
};
url: {
format: string;
type: string;
};
wait_for_device_creation: {
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
connected_account: {
properties: {
account_type: {
type: string;
};
account_type_display_name: {
type: string;
};
automatically_manage_new_devices: {
type: string;
};
connected_account_id: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
errors: {
items: {
properties: {
error_code: {
type: string;
};
is_connected_account_error: {
enum: (...)[];
type: string;
};
message: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
user_identifier: {
properties: {
api_url: {
type: string;
};
email: {
type: string;
};
exclusive: {
type: string;
};
phone: {
type: string;
};
username: {
type: string;
};
};
type: string;
};
warnings: {
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
device: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
capabilities_supported: {
description: string;
items: {
enum: string[];
type: string;
};
type: string;
};
connected_account_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
device_type: {
description: string;
oneOf: {
enum: string[];
type: string;
}[];
};
display_name: {
description: string;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
description: string;
enum: boolean[];
type: string;
};
location: {
description: string;
nullable: boolean;
properties: {
location_name: {
description: string;
type: string;
};
timezone: {
description: string;
type: string;
};
};
type: string;
};
nickname: {
description: string;
type: string;
};
properties: {
allOf: ({
allOf: (...)[];
} | {
allOf: (...)[];
})[];
description: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
device_provider: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
device_provider_name: {
enum: string[];
type: string;
};
display_name: {
type: string;
};
image_url: {
type: string;
};
provider_categories: {
items: {
enum: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
enrollment_automation: {
description: string;
properties: {
created_at: {
description: string;
format: string;
type: string;
};
credential_manager_acs_system_id: {
description: string;
format: string;
type: string;
};
enrollment_automation_id: {
description: string;
format: string;
type: string;
};
user_identity_id: {
description: string;
format: string;
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
event: {
properties: {
acs_credential_id: {
format: string;
type: string;
};
acs_system_id: {
format: string;
type: string;
};
acs_user_id: {
format: string;
type: string;
};
action_attempt_id: {
format: string;
type: string;
};
client_session_id: {
format: string;
type: string;
};
climate_preset_key: {
type: string;
};
cooling_set_point_celsius: {
format: string;
type: string;
};
cooling_set_point_fahrenheit: {
format: string;
type: string;
};
created_at: {
format: string;
type: string;
};
device_id: {
format: string;
type: string;
};
enrollment_automation_id: {
format: string;
type: string;
};
event_description: {
type: string;
};
event_id: {
format: string;
type: string;
};
event_type: {
type: string;
};
fan_mode_setting: {
type: string;
};
heating_set_point_celsius: {
format: string;
type: string;
};
heating_set_point_fahrenheit: {
format: string;
type: string;
};
hvac_mode_setting: {
type: string;
};
is_fallback_climate_preset: {
type: string;
};
method: {
type: string;
};
occurred_at: {
format: string;
type: string;
};
thermostat_schedule_id: {
format: string;
nullable: boolean;
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
network: {
properties: {
created_at: {
format: string;
type: string;
};
display_name: {
type: string;
};
network_id: {
format: string;
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
noise_threshold: {
properties: {
device_id: {
format: string;
type: string;
};
ends_daily_at: {
type: string;
};
name: {
type: string;
};
noise_threshold_decibels: {
format: string;
type: string;
};
noise_threshold_id: {
format: string;
type: string;
};
noise_threshold_nrs: {
format: string;
type: string;
};
starts_daily_at: {
type: string;
};
};
required: string[];
type: string;
};
phone: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
capabilities_supported: {
description: string;
items: {
enum: string[];
type: string;
};
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
custom_metadata: {
additionalProperties: {
oneOf: {
type: string;
}[];
};
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
device_type: {
enum: string[];
type: string;
};
display_name: {
description: string;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
description: string;
enum: boolean[];
type: string;
};
location: {
description: string;
nullable: boolean;
properties: {
location_name: {
description: string;
type: string;
};
timezone: {
description: string;
type: string;
};
};
type: string;
};
nickname: {
description: string;
type: string;
};
properties: {
properties: {
assa_abloy_credential_service_metadata: {
properties: {
endpoints: {
items: ...;
type: ...;
};
has_active_endpoint: {
type: ...;
};
};
required: string[];
type: string;
};
};
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
service_health: {
properties: {
description: {
type: string;
};
service: {
type: string;
};
status: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
thermostat_schedule: {
description: string;
properties: {
climate_preset_key: {
description: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
ends_at: {
description: string;
format: string;
type: string;
};
errors: {
description: string;
};
max_override_period_minutes: {
description: string;
minimum: number;
type: string;
};
name: {
description: string;
type: string;
};
starts_at: {
description: string;
format: string;
type: string;
};
thermostat_schedule_id: {
description: string;
format: string;
type: string;
};
unstable_is_override_allowed: {
description: string;
type: string;
x-undocumented: string;
};
};
required: string[];
type: string;
};
unmanaged_access_code: {
properties: {
access_code_id: {
description: string;
format: string;
type: string;
};
code: {
description: string;
nullable: boolean;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
ends_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
name: {
description: string;
nullable: boolean;
type: string;
};
starts_at: {
description: string;
format: string;
nullable: boolean;
type: string;
};
status: {
enum: string[];
type: string;
};
type: {
description: string;
enum: string[];
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
};
required: string[];
type: string;
};
unmanaged_device: {
properties: {
can_hvac_cool: {
type: string;
};
can_hvac_heat: {
type: string;
};
can_hvac_heat_cool: {
type: string;
};
can_program_offline_access_codes: {
type: string;
};
can_program_online_access_codes: {
type: string;
};
can_remotely_lock: {
type: string;
};
can_remotely_unlock: {
type: string;
};
can_simulate_connection: {
type: string;
};
can_simulate_disconnection: {
type: string;
};
can_simulate_removal: {
type: string;
};
can_turn_off_hvac: {
type: string;
};
capabilities_supported: {
description: string;
items: {
enum: string[];
type: string;
};
type: string;
};
connected_account_id: {
description: string;
format: string;
type: string;
};
created_at: {
description: string;
format: string;
type: string;
};
device_id: {
description: string;
format: string;
type: string;
};
device_type: {
description: string;
oneOf: {
enum: string[];
type: string;
}[];
};
errors: {
description: string;
items: {
oneOf: ({
properties: ...;
required: ...;
type: ...;
} | {
properties: ...;
required: ...;
type: ...;
})[];
};
type: string;
};
is_managed: {
enum: boolean[];
type: string;
};
location: {
description: string;
nullable: boolean;
properties: {
location_name: {
description: string;
type: string;
};
timezone: {
description: string;
type: string;
};
};
type: string;
};
properties: {
properties: {
accessory_keypad: {
description: string;
properties: {
battery: {
description: ...;
properties: ...;
required: ...;
type: ...;
};
is_connected: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
battery: {
description: string;
properties: {
level: {
format: ...;
maximum: ...;
minimum: ...;
type: ...;
};
status: {
enum: ...;
type: ...;
};
};
required: string[];
type: string;
};
battery_level: {
description: string;
format: string;
maximum: number;
minimum: number;
type: string;
};
image_alt_text: {
description: string;
type: string;
};
image_url: {
description: string;
format: string;
type: string;
};
manufacturer: {
description: string;
type: string;
};
model: {
properties: {
accessory_keypad_supported: {
deprecated: ...;
type: ...;
x-deprecated: ...;
};
can_connect_accessory_keypad: {
description: ...;
type: ...;
};
display_name: {
description: ...;
type: ...;
};
has_built_in_keypad: {
description: ...;
type: ...;
};
manufacturer_display_name: {
description: ...;
type: ...;
};
offline_access_codes_supported: {
description: ...;
type: ...;
};
online_access_codes_supported: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
name: {
deprecated: boolean;
description: string;
type: string;
x-deprecated: string;
};
offline_access_codes_enabled: {
description: string;
type: string;
};
online: {
description: string;
type: string;
};
online_access_codes_enabled: {
description: string;
type: string;
};
};
required: string[];
type: string;
};
warnings: {
description: string;
items: {
properties: {
message: {
type: string;
};
warning_code: {
type: string;
};
};
required: string[];
type: string;
};
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
user_identity: {
description: string;
properties: {
created_at: {
description: string;
format: string;
type: string;
};
display_name: {
minLength: number;
type: string;
};
email_address: {
description: string;
format: string;
nullable: boolean;
type: string;
};
full_name: {
minLength: number;
nullable: boolean;
type: string;
};
phone_number: {
description: string;
nullable: boolean;
type: string;
};
user_identity_id: {
description: string;
format: string;
type: string;
};
user_identity_key: {
description: string;
minLength: number;
nullable: boolean;
type: string;
};
workspace_id: {
description: string;
format: string;
type: string;
};
};
required: string[];
type: string;
};
webhook: {
properties: {
event_types: {
items: {
type: string;
};
type: string;
};
secret: {
type: string;
};
url: {
type: string;
};
webhook_id: {
type: string;
};
};
required: string[];
type: string;
};
workspace: {
properties: {
company_name: {
type: string;
};
connect_partner_name: {
deprecated: boolean;
nullable: boolean;
type: string;
x-deprecated: string;
};
is_sandbox: {
type: string;
};
name: {
type: string;
};
workspace_id: {
format: string;
type: string;
};
};
required: string[];
type: string;
};
};
securitySchemes: {
access_token: {
bearerFormat: string;
scheme: string;
type: string;
};
api_key: {
bearerFormat: string;
scheme: string;
type: string;
};
client_session: {
bearerFormat: string;
scheme: string;
type: string;
};
client_session_token: {
in: string;
name: string;
type: string;
};
console_session: {
bearerFormat: string;
scheme: string;
type: string;
};
pat_with_workspace: {
bearerFormat: string;
scheme: string;
type: string;
};
pat_without_workspace: {
bearerFormat: string;
scheme: string;
type: string;
};
seam_client_session_token: {
in: string;
name: string;
type: string;
};
seam_workspace: {
in: string;
name: string;
type: string;
};
user_session: {
bearerFormat: string;
scheme: string;
type: string;
};
user_session_without_workspace: {
bearerFormat: string;
scheme: string;
type: string;
};
};
};
info: {
title: string;
version: string;
};
openapi: string;
paths: {
/access_codes/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
common_code_key: {
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/create_multiple: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
behavior_when_code_cannot_be_shared: {
default: ...;
enum: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_ids: {
items: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
behavior_when_code_cannot_be_shared: {
default: ...;
enum: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_ids: {
items: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
};
/access_codes/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/generate_code: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
generated_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
code: {
type: ...;
};
device_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
access_token?: undefined;
api_key: never[];
client_session?: undefined;
user_session?: undefined;
}
| {
access_token: never[];
api_key?: undefined;
client_session?: undefined;
user_session?: undefined;
}
| {
access_token?: undefined;
api_key?: undefined;
client_session?: undefined;
user_session: never[];
}
| {
access_token?: undefined;
api_key?: undefined;
client_session: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_ids: {
items: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/pull_backup_access_code: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
backup_access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/simulate/create_unmanaged_access_code: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/unmanaged/convert_to_managed: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/unmanaged/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/unmanaged/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
code: {
type: ...;
};
device_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_code: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/unmanaged/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
access_codes: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/access_codes/unmanaged/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
force: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/access_codes/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
type: {
enum: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
type: {
enum: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
allow_external_modification: {
type: ...;
};
attempt_for_offline_device: {
default: ...;
type: ...;
};
code: {
maxLength: ...;
minLength: ...;
pattern: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
ends_at: {
type: ...;
};
is_external_modification_allowed: {
type: ...;
};
is_managed: {
type: ...;
};
is_offline_access_code: {
type: ...;
};
is_one_time_use: {
type: ...;
};
max_time_rounding: {
default: ...;
enum: ...;
type: ...;
};
name: {
type: ...;
};
prefer_native_scheduling: {
type: ...;
};
preferred_code_length: {
format: ...;
type: ...;
};
starts_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
type: {
enum: ...;
type: ...;
};
use_backup_access_code_pool: {
type: ...;
};
use_offline_access_code: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
};
/access_codes/update_multiple: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
common_code_key: {
type: ...;
};
ends_at: {
type: ...;
};
name: {
type: ...;
};
starts_at: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
common_code_key: {
type: ...;
};
ends_at: {
type: ...;
};
name: {
type: ...;
};
starts_at: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
};
};
/acs/access_groups/add_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/acs/access_groups/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_group: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_groups: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/list_accessible_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/list_users: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/access_groups/remove_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/access_groups/unmanaged/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_group: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/access_groups/unmanaged/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_access_groups: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/credential_pools/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential_pools: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/credential_provisioning_automations/launch: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_pool_id: {
format: ...;
type: ...;
};
create_credential_manager_user: {
type: ...;
};
credential_manager_acs_system_id: {
format: ...;
type: ...;
};
credential_manager_acs_user_id: {
format: ...;
type: ...;
};
user_identity_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential_provisioning_automation: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/credentials/assign: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/credentials/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_method: {
description: ...;
enum: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
allowed_acs_entrance_ids: {
default: ...;
description: ...;
items: ...;
type: ...;
};
assa_abloy_vostio_metadata: {
description: ...;
properties: ...;
type: ...;
};
code: {
description: ...;
pattern: ...;
type: ...;
};
credential_manager_acs_system_id: {
description: ...;
format: ...;
type: ...;
};
ends_at: {
description: ...;
format: ...;
type: ...;
};
is_multi_phone_sync_credential: {
default: ...;
description: ...;
type: ...;
};
starts_at: {
description: ...;
format: ...;
type: ...;
};
visionline_metadata: {
description: ...;
properties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/credentials/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
allOf: ((...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credentials: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/list_accessible_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/credentials/unassign: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/credentials/unmanaged/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
x-undocumented: string;
};
};
/acs/credentials/unmanaged/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: (
| (...)
| (...)
| (...)
| (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credentials: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
x-undocumented: string;
};
};
/acs/credentials/update: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
type: ...;
};
code: {
description: ...;
pattern: ...;
type: ...;
};
ends_at: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
type: ...;
};
code: {
description: ...;
pattern: ...;
type: ...;
};
ends_at: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credential: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/encoders/encode_credential: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
description: ...;
format: ...;
type: ...;
};
acs_encoder_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/encoders/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: ((...) | (...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_encoders: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/encoders/scan_credential: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_encoder_id: {
description: ...;
format: ...;
type: ...;
};
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/entrances/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_entrance_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrance: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
access_token?: undefined;
api_key: never[];
client_session?: undefined;
user_session?: undefined;
}
| {
access_token: never[];
api_key?: undefined;
client_session?: undefined;
user_session?: undefined;
}
| {
access_token?: undefined;
api_key?: undefined;
client_session?: undefined;
user_session: never[];
}
| {
access_token?: undefined;
api_key?: undefined;
client_session: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/entrances/grant_access: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_entrance_id: {
format: ...;
type: ...;
};
acs_user_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/entrances/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
format: ...;
type: ...;
};
acs_system_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/entrances/list_credentials_with_access: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_entrance_id: {
format: ...;
type: ...;
};
include_if: {
items: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_credentials: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/systems/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_system: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/systems/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_systems: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/systems/list_compatible_credential_manager_acs_systems: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_systems: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/add_to_access_group: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/acs/users/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_schedule: {
description: ...;
properties: ...;
required: ...;
type: ...;
};
acs_access_group_ids: {
default: ...;
description: ...;
items: ...;
type: ...;
};
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
email: {
deprecated: ...;
format: ...;
type: ...;
x-deprecated: ...;
};
email_address: {
description: ...;
format: ...;
type: ...;
};
full_name: {
description: ...;
type: ...;
};
phone_number: {
description: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_user: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_user: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
description: ...;
format: ...;
type: ...;
};
created_before: {
format: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
user_identity_email_address: {
description: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_phone_number: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/list_accessible_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_entrances: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/acs/users/remove_from_access_group: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_access_group_id: {
description: ...;
format: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/revoke_access_to_all_entrances: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/suspend: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/unmanaged/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_user: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/users/unmanaged/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_system_id: {
format: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
user_identity_email_address: {
type: ...;
};
user_identity_id: {
format: ...;
type: ...;
};
user_identity_phone_number: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-undocumented: string;
};
};
/acs/users/unsuspend: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/acs/users/update: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_schedule: {
description: ...;
nullable: ...;
properties: ...;
required: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
email: {
deprecated: ...;
format: ...;
type: ...;
x-deprecated: ...;
};
email_address: {
description: ...;
format: ...;
type: ...;
};
full_name: {
description: ...;
type: ...;
};
hid_acs_system_id: {
format: ...;
type: ...;
};
phone_number: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_schedule: {
description: ...;
nullable: ...;
properties: ...;
required: ...;
type: ...;
};
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
email: {
deprecated: ...;
format: ...;
type: ...;
x-deprecated: ...;
};
email_address: {
description: ...;
format: ...;
type: ...;
};
full_name: {
description: ...;
type: ...;
};
hid_acs_system_id: {
format: ...;
type: ...;
};
phone_number: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/action_attempts/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
action_attempt_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/action_attempts/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
action_attempt_ids: {
items: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempts: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/client_sessions/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
};
/client_sessions/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/client_sessions/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
user_identifier_key: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/client_sessions/get_or_create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
expires_at: {
format: ...;
type: ...;
};
user_identifier_key: {
minLength: ...;
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
};
/client_sessions/grant_access: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
connect_webview_ids: {
items: ...;
type: ...;
};
connected_account_ids: {
items: ...;
type: ...;
};
user_identifier_key: {
type: ...;
};
user_identity_ids: {
items: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_session: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/client_sessions/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
type: ...;
};
connect_webview_id: {
type: ...;
};
user_identifier_key: {
type: ...;
};
user_identity_id: {
type: ...;
};
without_user_identifier_key: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
client_sessions: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/client_sessions/revoke: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
client_session_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/connect_webviews/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
accepted_providers: {
items: ...;
type: ...;
};
automatically_manage_new_devices: {
default: ...;
type: ...;
};
custom_metadata: {
additionalProperties: ...;
type: ...;
};
custom_redirect_failure_url: {
type: ...;
};
custom_redirect_url: {
type: ...;
};
device_selection_mode: {
enum: ...;
type: ...;
};
provider_category: {
enum: ...;
type: ...;
};
wait_for_device_creation: {
default: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connect_webview: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connect_webviews/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/connect_webviews/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connect_webview: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connect_webviews/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connect_webviews: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connected_accounts/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connected_account_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/connected_accounts/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: ((...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connected_account: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connected_accounts/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connected_accounts: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/connected_accounts/update: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
automatically_manage_new_devices: {
type: ...;
};
connected_account_id: {
format: ...;
type: ...;
};
custom_metadata: {
additionalProperties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
connected_account: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/devices/list_device_providers: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
provider_category: {
enum: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device_providers: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/simulate/connect: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/simulate/disconnect: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/simulate/remove: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/unmanaged/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/unmanaged/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/devices/unmanaged/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
is_managed: {
enum: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
is_managed: {
enum: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/devices/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata: {
additionalProperties: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
is_managed: {
default: ...;
type: ...;
};
name: {
nullable: ...;
type: ...;
};
properties: {
properties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
custom_metadata: {
additionalProperties: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
is_managed: {
default: ...;
type: ...;
};
name: {
nullable: ...;
type: ...;
};
properties: {
properties: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/events/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
event_id: {
format: ...;
type: ...;
};
event_type: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
event: ...;
message: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/events/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
access_code_id: {
format: ...;
type: ...;
};
access_code_ids: {
items: ...;
type: ...;
};
acs_system_id: {
format: ...;
type: ...;
};
acs_system_ids: {
items: ...;
type: ...;
};
between: {
items: ...;
maxItems: ...;
minItems: ...;
type: ...;
};
connect_webview_id: {
format: ...;
type: ...;
};
connected_account_id: {
format: ...;
type: ...;
};
device_id: {
format: ...;
type: ...;
};
device_ids: {
items: ...;
type: ...;
};
event_type: {
enum: ...;
type: ...;
};
event_types: {
items: ...;
type: ...;
};
limit: {
default: ...;
format: ...;
type: ...;
};
since: {
type: ...;
};
unstable_offset: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
events: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
name: {
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
device: ...;
lock: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
locks: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/lock_door: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/locks/unlock_door: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/networks/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
network_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
network: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/networks/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
networks: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
noise_sensors: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
noise_threshold: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/noise_sensors/noise_thresholds/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
noise_threshold_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
noise_threshold: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
is_programmed: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
noise_thresholds: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/noise_sensors/noise_thresholds/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
ends_daily_at: {
type: ...;
};
name: {
type: ...;
};
noise_threshold_decibels: {
format: ...;
type: ...;
};
noise_threshold_id: {
format: ...;
type: ...;
};
noise_threshold_nrs: {
format: ...;
type: ...;
};
starts_daily_at: {
type: ...;
};
sync: {
default: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
};
/noise_sensors/simulate/trigger_noise_threshold: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/phones/deactivate: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/phones/list: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_id: {
format: ...;
type: ...;
};
owner_user_identity_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
phones: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/phones/simulate/create_sandbox_phone: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
assa_abloy_metadata: {
default: ...;
properties: ...;
type: ...;
};
custom_sdk_installation_id: {
type: ...;
};
phone_metadata: {
default: ...;
properties: ...;
type: ...;
};
user_identity_id: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
phone: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/thermostats/activate_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/cool: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/create_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
hvac_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
manual_override_allowed: {
default: ...;
type: ...;
};
name: {
default: ...;
description: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/delete_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-deprecated: string;
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
x-undocumented: string;
};
};
/thermostats/heat: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/heat_cool: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
connect_webview_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_id: {
description: ...;
format: ...;
type: ...;
};
connected_account_ids: {
description: ...;
items: ...;
type: ...;
};
created_before: {
description: ...;
format: ...;
type: ...;
};
custom_metadata_has: {
additionalProperties: ...;
description: ...;
type: ...;
};
device_ids: {
description: ...;
items: ...;
type: ...;
};
device_type: {
description: ...;
oneOf: ...;
};
device_types: {
description: ...;
items: ...;
type: ...;
};
exclude_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
include_if: {
items: ...;
type: ...;
x-undocumented: ...;
};
limit: {
default: ...;
description: ...;
format: ...;
type: ...;
};
manufacturer: {
description: ...;
enum: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
devices: ...;
ok: ...;
thermostats: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/off: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
type: ...;
};
ends_at: {
description: ...;
type: ...;
};
is_override_allowed: {
default: ...;
type: ...;
};
max_override_period_minutes: {
default: ...;
description: ...;
minimum: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
starts_at: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat_schedule: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/schedules/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat_schedule: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identifier_key: {
description: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
thermostat_schedules: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/schedules/update: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
ends_at: {
description: ...;
type: ...;
};
is_override_allowed: {
type: ...;
};
max_override_period_minutes: {
description: ...;
minimum: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
starts_at: {
description: ...;
type: ...;
};
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
ends_at: {
description: ...;
type: ...;
};
is_override_allowed: {
type: ...;
};
max_override_period_minutes: {
description: ...;
minimum: ...;
type: ...;
};
name: {
description: ...;
type: ...;
};
starts_at: {
description: ...;
type: ...;
};
thermostat_schedule_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/set_fallback_climate_preset: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/set_fan_mode: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
format: ...;
type: ...;
};
fan_mode: {
deprecated: ...;
enum: ...;
type: ...;
x-deprecated: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
sync: {
default: ...;
type: ...;
x-undocumented: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/thermostats/set_temperature_threshold: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
lower_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
lower_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
lower_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
lower_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_celsius: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
upper_limit_fahrenheit: {
default: ...;
description: ...;
format: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/thermostats/update_climate_preset: {
patch: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
hvac_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
manual_override_allowed: {
deprecated: ...;
description: ...;
type: ...;
x-deprecated: ...;
};
name: {
default: ...;
description: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
climate_preset_key: {
description: ...;
type: ...;
};
cooling_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
cooling_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
device_id: {
description: ...;
format: ...;
type: ...;
};
fan_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
heating_set_point_celsius: {
description: ...;
format: ...;
type: ...;
};
heating_set_point_fahrenheit: {
description: ...;
format: ...;
type: ...;
};
hvac_mode_setting: {
description: ...;
enum: ...;
type: ...;
};
manual_override_allowed: {
deprecated: ...;
description: ...;
type: ...;
x-deprecated: ...;
};
name: {
default: ...;
description: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/add_acs_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/user_identities/create: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
email_address: {
description: ...;
format: ...;
nullable: ...;
type: ...;
};
full_name: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
phone_number: {
description: ...;
nullable: ...;
type: ...;
};
user_identity_key: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
user_identity: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/enrollment_automations/delete: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/enrollment_automations/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/enrollment_automations/launch: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_credential_pool_id: {
description: ...;
format: ...;
type: ...;
};
create_credential_manager_user: {
description: ...;
type: ...;
};
credential_manager_acs_system_id: {
description: ...;
format: ...;
type: ...;
};
credential_manager_acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
enrollment_automation: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/enrollment_automations/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
enrollment_automations: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/get: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
oneOf: ((...) | (...))[];
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
user_identity: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/grant_access_to_device: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
put: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
x-title: string;
};
};
/user_identities/list: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
credential_manager_acs_system_id: {
format: ...;
type: ...;
};
};
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
user_identities: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/list_accessible_devices: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
accessible_devices: ...;
devices: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/list_acs_systems: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_systems: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
}
| {
api_key?: undefined;
client_session?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
}
| {
api_key: never[];
client_session?: undefined;
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/list_acs_users: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
acs_users: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
x-title: string;
};
};
/user_identities/remove_acs_user: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
acs_user_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/revoke_access_to_device: {
post: {
description: string;
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
device_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
x-title: string;
};
};
/user_identities/update: {
patch: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
email_address: {
description: ...;
format: ...;
nullable: ...;
type: ...;
};
full_name: {
minLength: ...;
nullable: ...;
type: ...;
};
phone_number: {
description: ...;
nullable: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_key: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
email_address: {
description: ...;
format: ...;
nullable: ...;
type: ...;
};
full_name: {
minLength: ...;
nullable: ...;
type: ...;
};
phone_number: {
description: ...;
nullable: ...;
type: ...;
};
user_identity_id: {
description: ...;
format: ...;
type: ...;
};
user_identity_key: {
description: ...;
minLength: ...;
nullable: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
} | {
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/webhooks/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
event_types: {
default: ...;
items: ...;
type: ...;
};
url: {
format: ...;
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhook: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/webhooks/delete: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
};
/webhooks/get: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhook: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/webhooks/list: {
get: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhooks: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
webhooks: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/webhooks/update: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
event_types: {
items: ...;
type: ...;
};
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-response-key: null;
};
put: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
event_types: {
items: ...;
type: ...;
};
webhook_id: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: null;
};
};
/workspaces/create: {
post: {
operationId: string;
requestBody: {
content: {
application/json: {
schema: {
properties: {
company_name: {
type: ...;
};
connect_partner_name: {
deprecated: ...;
nullable: ...;
type: ...;
x-deprecated: ...;
};
is_sandbox: {
default: ...;
type: ...;
};
name: {
type: ...;
};
webview_logo_shape: {
enum: ...;
type: ...;
};
webview_primary_button_color: {
type: ...;
};
webview_primary_button_text_color: {
type: ...;
};
};
required: string[];
type: string;
};
};
};
};
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspace: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: {
pat_without_workspace: never[];
}[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/workspaces/get: {
get: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspace: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
user_session: never[];
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspace: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
user_session: never[];
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
user_session?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
user_session?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/workspaces/list: {
get: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspaces: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace: never[];
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session: never[];
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace: never[];
}
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-ignore: boolean;
x-response-key: string;
};
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
ok: ...;
workspaces: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: (
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace: never[];
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace: never[];
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session: never[];
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace: never[];
}
| {
api_key: never[];
client_session?: undefined;
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
}
| {
api_key?: undefined;
client_session: never[];
pat_with_workspace?: undefined;
pat_without_workspace?: undefined;
user_session?: undefined;
user_session_without_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
/workspaces/reset_sandbox: {
post: {
operationId: string;
responses: {
200: {
content: {
application/json: {
schema: {
properties: {
action_attempt: ...;
ok: ...;
};
required: (...)[];
type: string;
};
};
};
description: string;
};
400: {
description: string;
};
401: {
description: string;
};
};
security: ({
api_key: never[];
console_session?: undefined;
pat_with_workspace?: undefined;
} | {
api_key?: undefined;
console_session?: undefined;
pat_with_workspace: never[];
} | {
api_key?: undefined;
console_session: never[];
pat_with_workspace?: undefined;
})[];
summary: string;
tags: string[];
x-fern-sdk-group-name: string[];
x-fern-sdk-method-name: string;
x-fern-sdk-return-value: string;
x-response-key: string;
};
};
};
servers: {
url: string;
}[];
tags: {
description: string;
name: string;
}[];
}>