Skip to content

Seam.md

Latest commit

 

History

History
433 lines (269 loc) · 16.6 KB

Seam.md

File metadata and controls

433 lines (269 loc) · 16.6 KB

seamapi / Exports / Seam

Class: Seam

Hierarchy

  • Routes

    ↳ Seam

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new Seam(apiKeyOrOptions?)

Parameters

Name Type
apiKeyOrOptions? string | SeamClientOptions

Overrides

Routes.constructor

Defined in

src/seam-connect/client.ts:72

Properties

accessCodes

• Readonly accessCodes: Object

Type declaration

Name Type
create (params: AccessCodeCreateOngoingRequest) => Promise<OngoingAccessCode>(params: AccessCodeCreateScheduledRequest) => Promise<TimeBoundAccessCode>
createMultiple (params: AccessCodeCreateMultipleOngoingRequest) => Promise<OngoingAccessCode[]>(params: AccessCodeCreateMultipleScheduledRequest) => Promise<TimeBoundAccessCode[]>
delete (params: AccessCodeDeleteRequest) => Promise<{ actionAttempt: ActionAttempt<ActionType> }>
generateCode (params: AccessCodeGenerateCodeRequest) => Promise<{ code: string ; device_id: string }>
get (params: AccessCodeGetRequest) => Promise<AccessCode>
list (params: AccessCodesListRequest) => Promise<AccessCode[]>
pullBackupAccessCode (params: PullBackupAccessCodeRequest) => Promise<AccessCode>
unmanaged Object
unmanaged.convertToManaged (params: UnmanagedAccessCodeConvertToManagedRequest) => Promise<{ actionAttempt: ActionAttempt<ActionType> }>
unmanaged.delete (params: UnmanagedAccessCodeDeleteRequest) => Promise<{ ok: true }>
unmanaged.get (params: UnmanagedAccessCodeGetRequest) => Promise<UnmanagedAccessCode>
unmanaged.list (params: UnmanagedAccessCodesListRequest) => Promise<UnmanagedAccessCode[]>
unmanaged.update (params: UnmanagedAccessCodeUpdateRequest) => Promise<{ ok: true }>
update (params: AccessCodeUpdateRequest, options?: { waitForCompletion?: boolean }) => Promise<ActionAttempt<"UPDATE_ACCESS_CODE">>

Inherited from

Routes.accessCodes

Defined in

src/seam-connect/routes.ts:323

actionAttempts

• Readonly actionAttempts: Object

Type declaration

Name Type
get <T>(actionAttemptId: string) => Promise<ActionAttempt<T>>

Inherited from

Routes.actionAttempts

Defined in

src/seam-connect/routes.ts:471

client

• client: AxiosInstance

Defined in

src/seam-connect/client.ts:70

clientSessions

• Readonly clientSessions: Object

Type declaration

Name Type
create (data: ClientSessionsCreateRequest) => Promise<ClientSession>
delete (params: ClientSessionsDeleteRequest) => Promise<{ ok: true }>
get (params: ClientSessionsGetRequest) => Promise<ClientSession>
getOrCreate (data: ClientSessionsCreateRequest) => Promise<ClientSession>
list (params: ClientSessionsListRequest) => Promise<Omit<ClientSession, "connected_account_ids" | "connect_webview_ids">[]>

Inherited from

Routes.clientSessions

Defined in

src/seam-connect/routes.ts:537

connectWebviews

• Readonly connectWebviews: Object

Type declaration

Name Type
create (params: ConnectWebviewCreateRequest) => Promise<Omit<ConnectWebview, "connected_account_id"> & { custom_redirect_failure_url: null | string ; custom_redirect_url: null | string }>
delete (params: ConnectWebviewDeleteRequest) => Promise<{ ok: true }>
get (connectWebviewId: string) => Promise<ConnectWebview>
list () => Promise<ConnectWebview[]>

Inherited from

Routes.connectWebviews

Defined in

src/seam-connect/routes.ts:291

connectedAccounts

• Readonly connectedAccounts: Object

Type declaration

Name Type
delete (params: ConnectedAccountsDeleteRequest) => Promise<{ ok: true }>
get (params: ConnectedAccountsGetRequest) => Promise<ConnectedAccount>
list () => Promise<ConnectedAccount[]>

Inherited from

Routes.connectedAccounts

Defined in

src/seam-connect/routes.ts:446

deviceModels

• Readonly deviceModels: Object

Type declaration

Name Type
list (__namedParameters: DeviceModelsListRequest & { acknowledge_intentional_use_of_internal_api?: boolean }) => Promise<DeviceModel[]>

Inherited from

Routes.deviceModels

Defined in

src/seam-connect/routes.ts:576

devices

• Readonly devices: Object

Type declaration

Name Type
delete (params: DeviceDeleteRequest) => Promise<{ ok: true }>
get (params: DeviceGetRequest) => Promise<Device<CommonDeviceProperties, string>>
list (params?: DevicesListRequest) => Promise<Device<CommonDeviceProperties, string>[]>
listDeviceProviders (params?: DeviceProvidersListRequest) => Promise<DeviceProvider[]>
unmanaged Object
unmanaged.get (params: DeviceGetRequest) => Promise<UnmanagedDevice>
unmanaged.list (params: DevicesListRequest) => Promise<UnmanagedDevice[]>
unmanaged.update (params: UnmanagedDeviceUpdateRequest) => Promise<{ ok: true }>
update (params: DeviceUpdateRequest) => Promise<{ ok: true }>

Inherited from

Routes.devices

Defined in

src/seam-connect/routes.ts:221

events

• Readonly events: Object

Type declaration

Name Type
get (params: EventGetRequest) => Promise<Event>
list (params?: EventsListRequest) => Promise<Event[]>

Inherited from

Routes.events

Defined in

src/seam-connect/routes.ts:273

locks

• Readonly locks: Object

Type declaration

Name Type
get (deviceId: string) => Promise<LockDevice>
list (connectedAccountId?: string) => Promise<LockDevice[]>
lockDoor (deviceId: string) => Promise<{ actionAttempt: ActionAttempt<ActionType> }>
unlockDoor (deviceId: string) => Promise<{ actionAttempt: ActionAttempt<ActionType> }>

Inherited from

Routes.locks

Defined in

src/seam-connect/routes.ts:186

noiseThresholds

• Readonly noiseThresholds: Object

Type declaration

Name Type
create (params: NoiseThresholdsCreateRequest) => Promise<{ ok: true }>
delete (params: NoiseThresholdsDeleteRequest) => Promise<{ ok: true }>
list (params: NoiseThresholdsListRequest) => Promise<NoiseThresholds[]>
update (params: NoiseThresholdsUpdateRequest) => Promise<{ ok: true }>

Inherited from

Routes.noiseThresholds

Defined in

src/seam-connect/routes.ts:481

thermostats

• Readonly thermostats: Object

Type declaration

Name Type
climateSettingSchedules Object
climateSettingSchedules.create (data: ClimateSettingScheduleBase) => Promise<ClimateSettingSchedule>
climateSettingSchedules.delete (params: ClimateSettingScheduleDeleteRequest) => Promise<void>
climateSettingSchedules.get (params: ClimateSettingScheduleGetRequest) => Promise<ClimateSettingSchedule>
climateSettingSchedules.list (params: ClimateSettingSchedulesListRequest) => Promise<ClimateSettingSchedule[]>
climateSettingSchedules.update (params: ClimateSettingScheduleUpdateRequest) => Promise<ClimateSettingSchedule>
delete (params: DeviceDeleteRequest) => Promise<{ ok: true }>
get (params: DeviceGetRequest) => Promise<Device<CommonDeviceProperties, string>>
list (params?: DevicesListRequest) => Promise<Device<CommonDeviceProperties, string>[]>
update (params: ThermostatUpdateRequest) => Promise<{ ok: true }>

Inherited from

Routes.thermostats

Defined in

src/seam-connect/routes.ts:596

webhooks

• Readonly webhooks: Object

Type declaration

Name Type
create (data: WebhookCreateRequest) => Promise<{ ok: true }>
delete (params: WebhookGetRequest) => Promise<{ ok: true }>
get (params: WebhookGetRequest) => Promise<Webhook>
list () => Promise<Webhook[]>

Inherited from

Routes.webhooks

Defined in

src/seam-connect/routes.ts:512

workspaces

• Readonly workspaces: Object

Type declaration

Name Type
get () => Promise<Workspace & { connect_partner_name: string }>
list () => Promise<Workspace[]>
resetSandbox () => Promise<SuccessfulAPIResponse<WorkspaceResetSandboxResponse>>

Inherited from

Routes.workspaces

Defined in

src/seam-connect/routes.ts:170

Methods

makeRequest

▸ makeRequest<T>(request): Promise<SuccessfulAPIResponse<T>>

Type parameters

Name
T

Parameters

Name Type
request AxiosRequestConfig<any>

Returns

Promise<SuccessfulAPIResponse<T>>

Overrides

Routes.makeRequest

Defined in

src/seam-connect/client.ts:108

getClientSessionToken

▸ Static getClientSessionToken(options): Promise<APIResponse<ClientSessionsCreateResponse>>

Parameters

Name Type
options Object
options.apiKey? string
options.endpoint? string
options.publishableKey? string
options.userIdentifierKey string
options.workspaceId? string

Returns

Promise<APIResponse<ClientSessionsCreateResponse>>

Defined in

src/seam-connect/client.ts:114