import { type Client } from '../../../../seam/connect/client.js'; import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../../../seam/connect/options.js'; import type { ActionAttempt } from '../../../../seam/connect/resources/action-attempt.js'; import type { Device } from '../../../../seam/connect/resources/device.js'; import { SeamHttpRequest } from '../../../../seam/connect/seam-http-request.js'; import { SeamPaginator } from '../../../../seam/connect/seam-paginator.js'; import { SeamHttpLocksSimulate } from './simulate/index.js'; export declare class SeamHttpLocks { client: Client; readonly defaults: Required; readonly ltsVersion = "1.0.0"; static ltsVersion: string; constructor(apiKeyOrOptions?: string | SeamHttpOptions); static fromClient(client: SeamHttpOptionsWithClient['client'], options?: Omit): SeamHttpLocks; static fromApiKey(apiKey: SeamHttpOptionsWithApiKey['apiKey'], options?: Omit): SeamHttpLocks; static fromClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options?: Omit): SeamHttpLocks; static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise; static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit): SeamHttpLocks; static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit): SeamHttpLocks; createPaginator(request: SeamHttpRequest): SeamPaginator; updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise; get simulate(): SeamHttpLocksSimulate; /** * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). */ configureAutoLock(parameters: LocksConfigureAutoLockParameters, options?: LocksConfigureAutoLockOptions): LocksConfigureAutoLockRequest; /** * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). * @deprecated Use `/devices/get` instead. */ get(parameters?: LocksGetParameters, options?: LocksGetOptions): LocksGetRequest; /** * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks). */ list(parameters?: LocksListParameters, options?: LocksListOptions): LocksListRequest; /** * Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). */ lockDoor(parameters: LocksLockDoorParameters, options?: LocksLockDoorOptions): LocksLockDoorRequest; /** * Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). */ unlockDoor(parameters: LocksUnlockDoorParameters, options?: LocksUnlockDoorOptions): LocksUnlockDoorRequest; } export type LocksConfigureAutoLockParameters = { /** * Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60. */ auto_lock_delay_seconds?: number | undefined; /** * Whether to enable or disable auto-lock. */ auto_lock_enabled: boolean; /** * ID of the lock for which you want to configure the auto-lock. */ device_id: string; }; /** * @deprecated Use LocksConfigureAutoLockRequest instead. */ export type LocksConfigureAutoLockResponse = { action_attempt: ActionAttempt; }; export type LocksConfigureAutoLockRequest = SeamHttpRequest; export type LocksConfigureAutoLockOptions = Pick; export type LocksGetParameters = { /** * ID of the lock that you want to get. */ device_id?: string | undefined; /** * Name of the lock that you want to get. */ name?: string | undefined; }; /** * @deprecated Use LocksGetRequest instead. */ export type LocksGetResponse = { device: Device; }; export type LocksGetRequest = SeamHttpRequest; export interface LocksGetOptions { } export type LocksListParameters = { /** * ID of the Connect Webview for which you want to list devices. */ connect_webview_id?: string | undefined; /** * ID of the connected account for which you want to list devices. */ connected_account_id?: string | undefined; /** * Array of IDs of the connected accounts for which you want to list devices. */ connected_account_ids?: Array | undefined; /** * Timestamp by which to limit returned devices. Returns devices created before this timestamp. */ created_before?: string | undefined; /** * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */ custom_metadata_has?: Record | undefined; /** * Customer key for which you want to list devices. */ customer_key?: string | undefined; /** * Array of device IDs for which you want to list devices. */ device_ids?: Array | undefined; /** * Device type of the locks that you want to list. */ 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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | undefined; /** * Device types of the locks that you want to list. */ device_types?: Array<'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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock'> | undefined; /** * Numerical limit on the number of devices to return. */ limit?: number | undefined; /** * Manufacturer of the locks that you want to list. */ manufacturer?: 'akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'korelock' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi' | undefined; /** * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */ page_cursor?: string | undefined; /** * String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */ search?: string | undefined; /** * ID of the space for which you want to list devices. */ space_id?: string | undefined; /** * @deprecated Use `space_id`. */ unstable_location_id?: string | undefined; /** * Your own internal user ID for the user for which you want to list devices. */ user_identifier_key?: string | undefined; }; /** * @deprecated Use LocksListRequest instead. */ export type LocksListResponse = { devices: Array; }; export type LocksListRequest = SeamHttpRequest; export interface LocksListOptions { } export type LocksLockDoorParameters = { /** * ID of the lock that you want to lock. */ device_id: string; }; /** * @deprecated Use LocksLockDoorRequest instead. */ export type LocksLockDoorResponse = { action_attempt: ActionAttempt; }; export type LocksLockDoorRequest = SeamHttpRequest; export type LocksLockDoorOptions = Pick; export type LocksUnlockDoorParameters = { /** * ID of the lock that you want to unlock. */ device_id: string; }; /** * @deprecated Use LocksUnlockDoorRequest instead. */ export type LocksUnlockDoorResponse = { action_attempt: ActionAttempt; }; export type LocksUnlockDoorRequest = SeamHttpRequest; export type LocksUnlockDoorOptions = Pick;