Class SeamHttpConnectWebviews
Constructors
constructor
- new SeamHttpConnectWebviews(apiKeyOrOptions?): SeamHttpConnectWebviews
Properties
client
client: AxiosInstance
Readonly
defaults
Methods
create
- create(body?): SeamHttpRequest<SetNonNullable<Required<{
connect_webview: {
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: null | string;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: null | string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
custom_redirect_failure_url: null | string;
custom_redirect_url: null | string;
device_selection_mode: "none" | "multiple" | "single";
login_successful: boolean;
selected_provider: null | string;
status: "failed" | "pending" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
};
}>, "connect_webview">, "connect_webview"> Parameters
Optional
body: {
accepted_providers?: (
| "linear"
| "assa_abloy_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "doorking"
| "dormakaba_community"
| "legic_connect"
| "akuvox"
| "august"
| "avigilon_alta"
| "brivo"
| "butterflymx"
| "schlage"
| "smartthings"
| "yale"
| "genie"
| "salto"
| "salto_ks"
| "lockly"
| "ttlock"
| "noiseaware"
| "nuki"
| "seam_relay_admin"
| "igloo"
| "kwikset"
| "minut"
| "my_2n"
| "controlbyweb"
| "nest"
| "igloohome"
| "ecobee"
| "hubitat"
| "four_suites"
| "dormakaba_oracode"
| "pti"
| "wyze"
| "seam_passport"
| "visionline"
| "seam_bridge"
| "tedee"
| "honeywell_resideo"
| "latch"
| "akiles"
| "tado"
| "salto_space"
| "yale_access"
| "hid_cm"
| "google_nest")[];
automatically_manage_new_devices?: boolean;
custom_metadata?: Record<string, null | string | boolean>;
custom_redirect_failure_url?: string;
custom_redirect_url?: string;
device_selection_mode?: "none" | "multiple" | "single";
provider_category?:
| "stable"
| "consumer_smartlocks"
| "thermostats"
| "noise_sensors"
| "access_control_systems"
| "internal_beta";
wait_for_device_creation?: boolean;
}Optional
accepted_providers?: (
| "linear"
| "assa_abloy_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "doorking"
| "dormakaba_community"
| "legic_connect"
| "akuvox"
| "august"
| "avigilon_alta"
| "brivo"
| "butterflymx"
| "schlage"
| "smartthings"
| "yale"
| "genie"
| "salto"
| "salto_ks"
| "lockly"
| "ttlock"
| "noiseaware"
| "nuki"
| "seam_relay_admin"
| "igloo"
| "kwikset"
| "minut"
| "my_2n"
| "controlbyweb"
| "nest"
| "igloohome"
| "ecobee"
| "hubitat"
| "four_suites"
| "dormakaba_oracode"
| "pti"
| "wyze"
| "seam_passport"
| "visionline"
| "seam_bridge"
| "tedee"
| "honeywell_resideo"
| "latch"
| "akiles"
| "tado"
| "salto_space"
| "yale_access"
| "hid_cm"
| "google_nest")[]
Optional
automatically_manage_new_devices?: boolean
Optional
custom_metadata?: Record<string, null | string | boolean>
Optional
custom_redirect_failure_url?: string
Optional
custom_redirect_url?: string
Optional
device_selection_mode?: "none" | "multiple" | "single"
Optional
provider_category?:
| "stable"
| "consumer_smartlocks"
| "thermostats"
| "noise_sensors"
| "access_control_systems"
| "internal_beta"
Optional
wait_for_device_creation?: boolean
Returns SeamHttpRequest<SetNonNullable<Required<{
connect_webview: {
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: null | string;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: null | string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
custom_redirect_failure_url: null | string;
custom_redirect_url: null | string;
device_selection_mode: "none" | "multiple" | "single";
login_successful: boolean;
selected_provider: null | string;
status: "failed" | "pending" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
};
}>, "connect_webview">, "connect_webview">
delete
- delete(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
connect_webview_id: string;
}connect_webview_id: string
get
- get(body?): SeamHttpRequest<SetNonNullable<Required<{
connect_webview: {
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: null | string;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: null | string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
custom_redirect_failure_url: null | string;
custom_redirect_url: null | string;
device_selection_mode: "none" | "multiple" | "single";
login_successful: boolean;
selected_provider: null | string;
status: "failed" | "pending" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
};
}>, "connect_webview">, "connect_webview"> Parameters
Optional
body: {
connect_webview_id: string;
}connect_webview_id: string
Returns SeamHttpRequest<SetNonNullable<Required<{
connect_webview: {
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: null | string;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: null | string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
custom_redirect_failure_url: null | string;
custom_redirect_url: null | string;
device_selection_mode: "none" | "multiple" | "single";
login_successful: boolean;
selected_provider: null | string;
status: "failed" | "pending" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
};
}>, "connect_webview">, "connect_webview">
list
- list(body?): SeamHttpRequest<SetNonNullable<Required<{
connect_webviews: {
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: null | string;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: null | string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
custom_redirect_failure_url: null | string;
custom_redirect_url: null | string;
device_selection_mode: "none" | "multiple" | "single";
login_successful: boolean;
selected_provider: null | string;
status: "failed" | "pending" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
}[];
}>, "connect_webviews">, "connect_webviews"> Parameters
Optional
body: {
custom_metadata_has?: Record<string, string | boolean>;
limit?: number;
user_identifier_key?: string;
}Optional
custom_metadata_has?: Record<string, string | boolean>
Optional
limit?: number
Optional
user_identifier_key?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
connect_webviews: {
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: null | string;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: null | string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
custom_redirect_failure_url: null | string;
custom_redirect_url: null | string;
device_selection_mode: "none" | "multiple" | "single";
login_successful: boolean;
selected_provider: null | string;
status: "failed" | "pending" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
}[];
}>, "connect_webviews">, "connect_webviews">
updateClientSessionToken
- updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
Static
fromClientSessionToken
- fromClientSessionToken(clientSessionToken, options?): SeamHttpConnectWebviews
Static
fromConsoleSessionToken
- fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpConnectWebviews
Static
fromPersonalAccessToken
- fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpConnectWebviews
Static
fromPublishableKey
- fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpConnectWebviews>
Returns webviews whose custom_metadata contains all of the provided key/value pairs.