Class SeamHttpDevicesUnmanaged

Hierarchy

SeamHttpDevicesUnmanaged

Index

Constructors

Properties

Methods

get list update fromApiKey fromClient fromClientSessionToken fromConsoleSessionToken fromPersonalAccessToken fromPublishableKey

Constructors

constructor

new SeamHttpDevicesUnmanaged(apiKeyOrOptions?): SeamHttpDevicesUnmanaged
Parameters
- apiKeyOrOptions: string | SeamHttpOptions = {}
Returns SeamHttpDevicesUnmanaged
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:38

Properties

client

client: AxiosInstance

`Readonly` defaults

defaults: Required<SeamHttpRequestOptions>

Methods

get

get(body?): Promise<{
    capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
    connected_account_id: string;
    created_at: string;
    device_id: string;
    device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    errors: {
        error_code: string;
        message: string;
    }[];
    is_managed: false;
    properties: {
        image_alt_text?: string;
        image_url?: string;
        manufacturer?: string;
        model: {
            display_name: string;
            manufacturer_display_name: string;
        };
        name: string;
        online: boolean;
    };
    warnings: {
        message: string;
        warning_code: string;
    }[];
    workspace_id: string;
}>
Parameters
- Optional body: {
  device_id?: string;
  name?: string;
  }
  - Optional device_id?: string
  - Optional name?: string
Returns Promise<{
    capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
    connected_account_id: string;
    created_at: string;
    device_id: string;
    device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    errors: {
        error_code: string;
        message: string;
    }[];
    is_managed: false;
    properties: {
        image_alt_text?: string;
        image_url?: string;
        manufacturer?: string;
        model: {
            display_name: string;
            manufacturer_display_name: string;
        };
        name: string;
        online: boolean;
    };
    warnings: {
        message: string;
        warning_code: string;
    }[];
    workspace_id: string;
}>
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:134

list

list(body?): Promise<{
    capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
    connected_account_id: string;
    created_at: string;
    device_id: string;
    device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    errors: {
        error_code: string;
        message: string;
    }[];
    is_managed: false;
    properties: {
        image_alt_text?: string;
        image_url?: string;
        manufacturer?: string;
        model: {
            display_name: string;
            manufacturer_display_name: string;
        };
        name: string;
        online: boolean;
    };
    warnings: {
        message: string;
        warning_code: string;
    }[];
    workspace_id: string;
}[]>
Parameters
- Optional body: {
      connect_webview_id?: string;
      connected_account_id?: string;
      connected_account_ids?: string[];
      created_before?: Date;
      device_ids?: string[];
      device_type?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      device_types?: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
      limit?: number;
      manufacturer?: "linear" | "unknown" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
      user_identifier_key?: string;
  }
  - Optional connect_webview_id?: string
  - Optional connected_account_id?: string
    List all devices owned by this connected account
  - Optional connected_account_ids?: string[]
  - Optional created_before?: Date
  - Optional device_ids?: string[]
  - Optional device_type?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
  - Optional device_types?: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[]
  - Optional limit?: number
  - Optional manufacturer?: "linear" | "unknown" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
  - Optional user_identifier_key?: string
Returns Promise<{
    capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
    connected_account_id: string;
    created_at: string;
    device_id: string;
    device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    errors: {
        error_code: string;
        message: string;
    }[];
    is_managed: false;
    properties: {
        image_alt_text?: string;
        image_url?: string;
        manufacturer?: string;
        model: {
            display_name: string;
            manufacturer_display_name: string;
        };
        name: string;
        online: boolean;
    };
    warnings: {
        message: string;
        warning_code: string;
    }[];
    workspace_id: string;
}[]>
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:146

update

update(body?): Promise<void>
Parameters
- Optional body: {
  device_id: string;
  is_managed: true;
  }
  - device_id: string
  - is_managed: true
Returns Promise<void>
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:158

`Static` fromApiKey

fromApiKey(apiKey, options?): SeamHttpDevicesUnmanaged
Parameters
- apiKey: string
- options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}
Returns SeamHttpDevicesUnmanaged
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:55

`Static` fromClient

fromClient(client, options?): SeamHttpDevicesUnmanaged
Parameters
- client: AxiosInstance
- options: Omit<SeamHttpOptionsWithClient, "client"> = {}
Returns SeamHttpDevicesUnmanaged
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:44

`Static` fromClientSessionToken

fromClientSessionToken(clientSessionToken, options?): SeamHttpDevicesUnmanaged
Parameters
- clientSessionToken: string
- options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}
Returns SeamHttpDevicesUnmanaged
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:66

`Static` fromConsoleSessionToken

fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpDevicesUnmanaged
Parameters
- consoleSessionToken: string
- workspaceId: string
- options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}
Returns SeamHttpDevicesUnmanaged
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:100

`Static` fromPersonalAccessToken

fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpDevicesUnmanaged
Parameters
- personalAccessToken: string
- workspaceId: string
- options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}
Returns SeamHttpDevicesUnmanaged
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:117

`Static` fromPublishableKey

fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpDevicesUnmanaged>
Parameters
- publishableKey: string
- userIdentifierKey: string
- options: SeamHttpFromPublishableKeyOptions = {}
Returns Promise<SeamHttpDevicesUnmanaged>
- Defined in src/lib/seam/connect/routes/devices-unmanaged.ts:80

Class SeamHttpDevicesUnmanaged

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

apiKeyOrOptions: string | SeamHttpOptions = {}

Returns SeamHttpDevicesUnmanaged

Properties

client

Readonly defaults

Methods

get

Parameters

Optional body: { device_id?: string; name?: string; }

Optional device_id?: string

Optional name?: string

list

Parameters

Optional connect_webview_id?: string

Optional connected_account_id?: string

Optional connected_account_ids?: string[]

Optional created_before?: Date

Optional device_ids?: string[]

Optional limit?: number

Optional user_identifier_key?: string

update

Parameters

Optional body: { device_id: string; is_managed: true; }

device_id: string

is_managed: true

Returns Promise<void>

Static fromApiKey

Parameters

apiKey: string

options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

Returns SeamHttpDevicesUnmanaged

Static fromClient

Parameters

client: AxiosInstance

options: Omit<SeamHttpOptionsWithClient, "client"> = {}

Returns SeamHttpDevicesUnmanaged

Static fromClientSessionToken

Parameters

clientSessionToken: string

options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

Returns SeamHttpDevicesUnmanaged

Static fromConsoleSessionToken

Parameters

consoleSessionToken: string

workspaceId: string

options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

Returns SeamHttpDevicesUnmanaged

Static fromPersonalAccessToken

Parameters

personalAccessToken: string

workspaceId: string

options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

Returns SeamHttpDevicesUnmanaged

Static fromPublishableKey

Parameters

publishableKey: string

userIdentifierKey: string

options: SeamHttpFromPublishableKeyOptions = {}

Returns Promise<SeamHttpDevicesUnmanaged>

Settings

Member Visibility

Theme

On This Page

`Readonly` defaults

`Optional` body: {
device_id?: string;
name?: string;
}

`Optional` device_id?: string

`Optional` name?: string

`Optional` connect_webview_id?: string

`Optional` connected_account_id?: string

`Optional` connected_account_ids?: string[]

`Optional` created_before?: Date

`Optional` device_ids?: string[]

`Optional` limit?: number

`Optional` user_identifier_key?: string

`Optional` body: {
device_id: string;
is_managed: true;
}

`Static` fromApiKey

`Static` fromClient

`Static` fromClientSessionToken

`Static` fromConsoleSessionToken

`Static` fromPersonalAccessToken

`Static` fromPublishableKey