@seamapi/http 2.1.0 → 2.3.0

package/src/lib/routes/devices/devices.ts

@@ -0,0 +1,1918 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+import {
+  getAuthHeadersForClientSessionToken,
+  warnOnInsecureuserIdentifierKey,
+} from 'lib/auth.js'
+import { type Client, createClient } from 'lib/client.js'
+import { seamApiLtsVersion } from 'lib/lts-version.js'
+import {
+  isSeamHttpOptionsWithApiKey,
+  isSeamHttpOptionsWithClient,
+  isSeamHttpOptionsWithClientSessionToken,
+  isSeamHttpOptionsWithConsoleSessionToken,
+  isSeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpFromPublishableKeyOptions,
+  SeamHttpInvalidOptionsError,
+  type SeamHttpOptions,
+  type SeamHttpOptionsWithApiKey,
+  type SeamHttpOptionsWithClient,
+  type SeamHttpOptionsWithClientSessionToken,
+  type SeamHttpOptionsWithConsoleSessionToken,
+  type SeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpRequestOptions,
+} from 'lib/options.js'
+import {
+  limitToSeamHttpRequestOptions,
+  parseOptions,
+} from 'lib/parse-options.js'
+import type { Device } from 'lib/resources/device.js'
+import type { DeviceProvider } from 'lib/resources/device-provider.js'
+import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
+import { SeamHttpRequest } from 'lib/seam-http-request.js'
+import { SeamPaginator } from 'lib/seam-paginator.js'
+
+import { SeamHttpDevicesSimulate } from './simulate/index.js'
+import { SeamHttpDevicesUnmanaged } from './unmanaged/index.js'
+
+export class SeamHttpDevices {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+  readonly ltsVersion = seamApiLtsVersion
+  static ltsVersion = seamApiLtsVersion
+
+  constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions)
+    this.client = 'client' in options ? options.client : createClient(options)
+    this.defaults = limitToSeamHttpRequestOptions(options)
+  }
+
+  static fromClient(
+    client: SeamHttpOptionsWithClient['client'],
+    options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
+  ): SeamHttpDevices {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpDevices(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpDevices {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpDevices(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpDevices {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpDevices(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpDevices> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttpDevices.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpDevices.fromClientSessionToken(token, options)
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpDevices {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpDevices(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpDevices {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpDevices(constructorOptions)
+  }
+
+  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
+    request: SeamHttpRequest<TResponse, TResponseKey>,
+  ): SeamPaginator<TResponse, TResponseKey> {
+    return new SeamPaginator<TResponse, TResponseKey>(this, request)
+  }
+
+  async updateClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+  ): Promise<void> {
+    const { headers } = this.client.defaults
+    const authHeaders = getAuthHeadersForClientSessionToken({
+      clientSessionToken,
+    })
+    for (const key of Object.keys(authHeaders)) {
+      if (headers[key] == null) {
+        throw new Error(
+          'Cannot update a clientSessionToken on a client created without a clientSessionToken',
+        )
+      }
+    }
+    this.client.defaults.headers = { ...headers, ...authHeaders }
+    const clientSessions = SeamHttpClientSessions.fromClient(this.client)
+    await clientSessions.get()
+  }
+
+  get simulate(): SeamHttpDevicesSimulate {
+    return SeamHttpDevicesSimulate.fromClient(this.client, this.defaults)
+  }
+
+  get unmanaged(): SeamHttpDevicesUnmanaged {
+    return SeamHttpDevicesUnmanaged.fromClient(this.client, this.defaults)
+  }
+
+  /**
+   * Returns a specified [device](https://docs.seam.co/core-concepts/devices).
+   *
+   * You must specify either `device_id` or `name`.
+   */
+  get(
+    parameters?: DevicesGetParameters,
+    options: DevicesGetOptions = {},
+  ): DevicesGetRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/devices/get',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'device',
+      options,
+    })
+  }
+
+  /**
+   * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices).
+   */
+  list(
+    parameters?: DevicesListParameters,
+    options: DevicesListOptions = {},
+  ): DevicesListRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/devices/list',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'devices',
+      options,
+    })
+  }
+
+  /**
+   * Returns a list of all device providers.
+   *
+   * The information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.
+   *
+   * When you create a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
+   */
+  listDeviceProviders(
+    parameters?: DevicesListDeviceProvidersParameters,
+    options: DevicesListDeviceProvidersOptions = {},
+  ): DevicesListDeviceProvidersRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/devices/list_device_providers',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'device_providers',
+      options,
+    })
+  }
+
+  /**
+   * Updates provider-specific metadata for devices.
+   */
+  reportProviderMetadata(
+    parameters: DevicesReportProviderMetadataParameters,
+    options: DevicesReportProviderMetadataOptions = {},
+  ): DevicesReportProviderMetadataRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/devices/report_provider_metadata',
+      method: 'POST',
+      body: parameters,
+      responseKey: undefined,
+      options,
+    })
+  }
+
+  /**
+   * Updates a specified [device](https://docs.seam.co/core-concepts/devices).
+   *
+   * You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+   */
+  update(
+    parameters: DevicesUpdateParameters,
+    options: DevicesUpdateOptions = {},
+  ): DevicesUpdateRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/devices/update',
+      method: 'PATCH',
+      body: parameters,
+      responseKey: undefined,
+      options,
+    })
+  }
+}
+
+export type DevicesGetParameters = {
+  /**
+   * ID of the device that you want to get.
+   */
+  device_id?: string | undefined
+  /**
+   * Name of the device that you want to get.
+   */
+  name?: string | undefined
+}
+
+/**
+ * @deprecated Use DevicesGetRequest instead.
+ */
+export type DevicesGetResponse = { device: Device }
+
+export type DevicesGetRequest = SeamHttpRequest<DevicesGetResponse, 'device'>
+
+export interface DevicesGetOptions {}
+
+export type DevicesListParameters = {
+  /**
+   * 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<string> | 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<string, unknown> | 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<string> | undefined
+  /**
+   * Device type for which you want to list devices.
+   */
+  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'
+    | 'keynest_key'
+    | 'noiseaware_activity_zone'
+    | 'minut_sensor'
+    | 'ecobee_thermostat'
+    | 'nest_thermostat'
+    | 'honeywell_resideo_thermostat'
+    | 'tado_thermostat'
+    | 'sensi_thermostat'
+    | 'smartthings_thermostat'
+    | 'ios_phone'
+    | 'android_phone'
+    | 'ring_camera'
+    | undefined
+  /**
+   * Array of device types for which you want to list devices.
+   */
+  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'
+        | 'keynest_key'
+        | 'noiseaware_activity_zone'
+        | 'minut_sensor'
+        | 'ecobee_thermostat'
+        | 'nest_thermostat'
+        | 'honeywell_resideo_thermostat'
+        | 'tado_thermostat'
+        | 'sensi_thermostat'
+        | 'smartthings_thermostat'
+        | 'ios_phone'
+        | 'android_phone'
+        | 'ring_camera'
+      >
+    | undefined
+  /**
+   * Numerical limit on the number of devices to return.
+   */
+  limit?: number | undefined
+  /**
+   * Manufacturer for which you want to list devices.
+   */
+  manufacturer?:
+    | 'akuvox'
+    | 'august'
+    | 'avigilon_alta'
+    | 'brivo'
+    | 'butterflymx'
+    | 'doorking'
+    | 'four_suites'
+    | 'genie'
+    | 'igloo'
+    | 'keywe'
+    | 'kwikset'
+    | 'linear'
+    | 'lockly'
+    | 'nuki'
+    | 'philia'
+    | 'salto'
+    | 'samsung'
+    | 'schlage'
+    | 'seam'
+    | 'unknown'
+    | 'wyze'
+    | 'yale'
+    | 'two_n'
+    | 'ttlock'
+    | 'igloohome'
+    | 'controlbyweb'
+    | 'dormakaba_oracode'
+    | 'tedee'
+    | 'keyincode'
+    | 'akiles'
+    | 'aqara'
+    | 'ecobee'
+    | 'honeywell_resideo'
+    | 'keynest'
+    | 'korelock'
+    | 'minut'
+    | 'nest'
+    | 'noiseaware'
+    | 'sensi'
+    | 'smartthings'
+    | 'tado'
+    | 'ultraloq'
+    | 'ring'
+    | 'ical'
+    | 'lodgify'
+    | 'hostaway'
+    | 'guesty'
+    | 'acuity_scheduling'
+    | 'omnitec'
+    | 'kisi'
+    | 'slack'
+    | 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 DevicesListRequest instead.
+ */
+export type DevicesListResponse = { devices: Array<Device> }
+
+export type DevicesListRequest = SeamHttpRequest<DevicesListResponse, 'devices'>
+
+export interface DevicesListOptions {}
+
+export type DevicesListDeviceProvidersParameters = {
+  /**
+   * Category for which you want to list providers.
+   */
+  provider_category?:
+    | 'stable'
+    | 'consumer_smartlocks'
+    | 'beta'
+    | 'thermostats'
+    | 'noise_sensors'
+    | 'access_control_systems'
+    | 'cameras'
+    | 'connectors'
+    | undefined
+}
+
+/**
+ * @deprecated Use DevicesListDeviceProvidersRequest instead.
+ */
+export type DevicesListDeviceProvidersResponse = {
+  device_providers: Array<DeviceProvider>
+}
+
+export type DevicesListDeviceProvidersRequest = SeamHttpRequest<
+  DevicesListDeviceProvidersResponse,
+  'device_providers'
+>
+
+export interface DevicesListDeviceProvidersOptions {}
+
+export type DevicesReportProviderMetadataParameters = {
+  /**
+   * Array of devices with provider metadata to update
+   */
+  devices: Array<{
+    /**
+     * ID of the device to update
+     */
+    device_id?: string | undefined
+    /**
+     * Omnitec-specific metadata to update
+     */
+    omnitec_metadata?:
+      | {
+          /**
+           * IANA timezone for the Omnitec device
+           */
+          time_zone?:
+            | 'Africa/Abidjan'
+            | 'Africa/Accra'
+            | 'Africa/Addis_Ababa'
+            | 'Africa/Algiers'
+            | 'Africa/Asmera'
+            | 'Africa/Bamako'
+            | 'Africa/Bangui'
+            | 'Africa/Banjul'
+            | 'Africa/Bissau'
+            | 'Africa/Blantyre'
+            | 'Africa/Brazzaville'
+            | 'Africa/Bujumbura'
+            | 'Africa/Cairo'
+            | 'Africa/Casablanca'
+            | 'Africa/Ceuta'
+            | 'Africa/Conakry'
+            | 'Africa/Dakar'
+            | 'Africa/Dar_es_Salaam'
+            | 'Africa/Djibouti'
+            | 'Africa/Douala'
+            | 'Africa/El_Aaiun'
+            | 'Africa/Freetown'
+            | 'Africa/Gaborone'
+            | 'Africa/Harare'
+            | 'Africa/Johannesburg'
+            | 'Africa/Juba'
+            | 'Africa/Kampala'
+            | 'Africa/Khartoum'
+            | 'Africa/Kigali'
+            | 'Africa/Kinshasa'
+            | 'Africa/Lagos'
+            | 'Africa/Libreville'
+            | 'Africa/Lome'
+            | 'Africa/Luanda'
+            | 'Africa/Lubumbashi'
+            | 'Africa/Lusaka'
+            | 'Africa/Malabo'
+            | 'Africa/Maputo'
+            | 'Africa/Maseru'
+            | 'Africa/Mbabane'
+            | 'Africa/Mogadishu'
+            | 'Africa/Monrovia'
+            | 'Africa/Nairobi'
+            | 'Africa/Ndjamena'
+            | 'Africa/Niamey'
+            | 'Africa/Nouakchott'
+            | 'Africa/Ouagadougou'
+            | 'Africa/Porto-Novo'
+            | 'Africa/Sao_Tome'
+            | 'Africa/Tripoli'
+            | 'Africa/Tunis'
+            | 'Africa/Windhoek'
+            | 'America/Adak'
+            | 'America/Anchorage'
+            | 'America/Anguilla'
+            | 'America/Antigua'
+            | 'America/Araguaina'
+            | 'America/Argentina/La_Rioja'
+            | 'America/Argentina/Rio_Gallegos'
+            | 'America/Argentina/Salta'
+            | 'America/Argentina/San_Juan'
+            | 'America/Argentina/San_Luis'
+            | 'America/Argentina/Tucuman'
+            | 'America/Argentina/Ushuaia'
+            | 'America/Aruba'
+            | 'America/Asuncion'
+            | 'America/Bahia'
+            | 'America/Bahia_Banderas'
+            | 'America/Barbados'
+            | 'America/Belem'
+            | 'America/Belize'
+            | 'America/Blanc-Sablon'
+            | 'America/Boa_Vista'
+            | 'America/Bogota'
+            | 'America/Boise'
+            | 'America/Buenos_Aires'
+            | 'America/Cambridge_Bay'
+            | 'America/Campo_Grande'
+            | 'America/Cancun'
+            | 'America/Caracas'
+            | 'America/Catamarca'
+            | 'America/Cayenne'
+            | 'America/Cayman'
+            | 'America/Chicago'
+            | 'America/Chihuahua'
+            | 'America/Ciudad_Juarez'
+            | 'America/Coral_Harbour'
+            | 'America/Cordoba'
+            | 'America/Costa_Rica'
+            | 'America/Creston'
+            | 'America/Cuiaba'
+            | 'America/Curacao'
+            | 'America/Danmarkshavn'
+            | 'America/Dawson'
+            | 'America/Dawson_Creek'
+            | 'America/Denver'
+            | 'America/Detroit'
+            | 'America/Dominica'
+            | 'America/Edmonton'
+            | 'America/Eirunepe'
+            | 'America/El_Salvador'
+            | 'America/Fort_Nelson'
+            | 'America/Fortaleza'
+            | 'America/Glace_Bay'
+            | 'America/Godthab'
+            | 'America/Goose_Bay'
+            | 'America/Grand_Turk'
+            | 'America/Grenada'
+            | 'America/Guadeloupe'
+            | 'America/Guatemala'
+            | 'America/Guayaquil'
+            | 'America/Guyana'
+            | 'America/Halifax'
+            | 'America/Havana'
+            | 'America/Hermosillo'
+            | 'America/Indiana/Knox'
+            | 'America/Indiana/Marengo'
+            | 'America/Indiana/Petersburg'
+            | 'America/Indiana/Tell_City'
+            | 'America/Indiana/Vevay'
+            | 'America/Indiana/Vincennes'
+            | 'America/Indiana/Winamac'
+            | 'America/Indianapolis'
+            | 'America/Inuvik'
+            | 'America/Iqaluit'
+            | 'America/Jamaica'
+            | 'America/Jujuy'
+            | 'America/Juneau'
+            | 'America/Kentucky/Monticello'
+            | 'America/Kralendijk'
+            | 'America/La_Paz'
+            | 'America/Lima'
+            | 'America/Los_Angeles'
+            | 'America/Louisville'
+            | 'America/Lower_Princes'
+            | 'America/Maceio'
+            | 'America/Managua'
+            | 'America/Manaus'
+            | 'America/Marigot'
+            | 'America/Martinique'
+            | 'America/Matamoros'
+            | 'America/Mazatlan'
+            | 'America/Mendoza'
+            | 'America/Menominee'
+            | 'America/Merida'
+            | 'America/Metlakatla'
+            | 'America/Mexico_City'
+            | 'America/Miquelon'
+            | 'America/Moncton'
+            | 'America/Monterrey'
+            | 'America/Montevideo'
+            | 'America/Montreal'
+            | 'America/Montserrat'
+            | 'America/Nassau'
+            | 'America/New_York'
+            | 'America/Nipigon'
+            | 'America/Nome'
+            | 'America/Noronha'
+            | 'America/North_Dakota/Beulah'
+            | 'America/North_Dakota/Center'
+            | 'America/North_Dakota/New_Salem'
+            | 'America/Ojinaga'
+            | 'America/Panama'
+            | 'America/Pangnirtung'
+            | 'America/Paramaribo'
+            | 'America/Phoenix'
+            | 'America/Port-au-Prince'
+            | 'America/Port_of_Spain'
+            | 'America/Porto_Velho'
+            | 'America/Puerto_Rico'
+            | 'America/Punta_Arenas'
+            | 'America/Rainy_River'
+            | 'America/Rankin_Inlet'
+            | 'America/Recife'
+            | 'America/Regina'
+            | 'America/Resolute'
+            | 'America/Rio_Branco'
+            | 'America/Santa_Isabel'
+            | 'America/Santarem'
+            | 'America/Santiago'
+            | 'America/Santo_Domingo'
+            | 'America/Sao_Paulo'
+            | 'America/Scoresbysund'
+            | 'America/Sitka'
+            | 'America/St_Barthelemy'
+            | 'America/St_Johns'
+            | 'America/St_Kitts'
+            | 'America/St_Lucia'
+            | 'America/St_Thomas'
+            | 'America/St_Vincent'
+            | 'America/Swift_Current'
+            | 'America/Tegucigalpa'
+            | 'America/Thule'
+            | 'America/Thunder_Bay'
+            | 'America/Tijuana'
+            | 'America/Toronto'
+            | 'America/Tortola'
+            | 'America/Vancouver'
+            | 'America/Whitehorse'
+            | 'America/Winnipeg'
+            | 'America/Yakutat'
+            | 'America/Yellowknife'
+            | 'Antarctica/Casey'
+            | 'Antarctica/Davis'
+            | 'Antarctica/DumontDUrville'
+            | 'Antarctica/Macquarie'
+            | 'Antarctica/Mawson'
+            | 'Antarctica/McMurdo'
+            | 'Antarctica/Palmer'
+            | 'Antarctica/Rothera'
+            | 'Antarctica/Syowa'
+            | 'Antarctica/Troll'
+            | 'Antarctica/Vostok'
+            | 'Arctic/Longyearbyen'
+            | 'Asia/Aden'
+            | 'Asia/Almaty'
+            | 'Asia/Amman'
+            | 'Asia/Anadyr'
+            | 'Asia/Aqtau'
+            | 'Asia/Aqtobe'
+            | 'Asia/Ashgabat'
+            | 'Asia/Atyrau'
+            | 'Asia/Baghdad'
+            | 'Asia/Bahrain'
+            | 'Asia/Baku'
+            | 'Asia/Bangkok'
+            | 'Asia/Barnaul'
+            | 'Asia/Beirut'
+            | 'Asia/Bishkek'
+            | 'Asia/Brunei'
+            | 'Asia/Calcutta'
+            | 'Asia/Chita'
+            | 'Asia/Choibalsan'
+            | 'Asia/Colombo'
+            | 'Asia/Damascus'
+            | 'Asia/Dhaka'
+            | 'Asia/Dili'
+            | 'Asia/Dubai'
+            | 'Asia/Dushanbe'
+            | 'Asia/Famagusta'
+            | 'Asia/Gaza'
+            | 'Asia/Hebron'
+            | 'Asia/Hong_Kong'
+            | 'Asia/Hovd'
+            | 'Asia/Irkutsk'
+            | 'Asia/Jakarta'
+            | 'Asia/Jayapura'
+            | 'Asia/Jerusalem'
+            | 'Asia/Kabul'
+            | 'Asia/Kamchatka'
+            | 'Asia/Karachi'
+            | 'Asia/Katmandu'
+            | 'Asia/Khandyga'
+            | 'Asia/Krasnoyarsk'
+            | 'Asia/Kuala_Lumpur'
+            | 'Asia/Kuching'
+            | 'Asia/Kuwait'
+            | 'Asia/Macau'
+            | 'Asia/Magadan'
+            | 'Asia/Makassar'
+            | 'Asia/Manila'
+            | 'Asia/Muscat'
+            | 'Asia/Nicosia'
+            | 'Asia/Novokuznetsk'
+            | 'Asia/Novosibirsk'
+            | 'Asia/Omsk'
+            | 'Asia/Oral'
+            | 'Asia/Phnom_Penh'
+            | 'Asia/Pontianak'
+            | 'Asia/Pyongyang'
+            | 'Asia/Qatar'
+            | 'Asia/Qostanay'
+            | 'Asia/Qyzylorda'
+            | 'Asia/Rangoon'
+            | 'Asia/Riyadh'
+            | 'Asia/Saigon'
+            | 'Asia/Sakhalin'
+            | 'Asia/Samarkand'
+            | 'Asia/Seoul'
+            | 'Asia/Shanghai'
+            | 'Asia/Singapore'
+            | 'Asia/Srednekolymsk'
+            | 'Asia/Taipei'
+            | 'Asia/Tashkent'
+            | 'Asia/Tbilisi'
+            | 'Asia/Tehran'
+            | 'Asia/Thimphu'
+            | 'Asia/Tokyo'
+            | 'Asia/Tomsk'
+            | 'Asia/Ulaanbaatar'
+            | 'Asia/Urumqi'
+            | 'Asia/Ust-Nera'
+            | 'Asia/Vientiane'
+            | 'Asia/Vladivostok'
+            | 'Asia/Yakutsk'
+            | 'Asia/Yekaterinburg'
+            | 'Asia/Yerevan'
+            | 'Atlantic/Azores'
+            | 'Atlantic/Bermuda'
+            | 'Atlantic/Canary'
+            | 'Atlantic/Cape_Verde'
+            | 'Atlantic/Faeroe'
+            | 'Atlantic/Madeira'
+            | 'Atlantic/Reykjavik'
+            | 'Atlantic/South_Georgia'
+            | 'Atlantic/St_Helena'
+            | 'Atlantic/Stanley'
+            | 'Australia/Adelaide'
+            | 'Australia/Brisbane'
+            | 'Australia/Broken_Hill'
+            | 'Australia/Currie'
+            | 'Australia/Darwin'
+            | 'Australia/Eucla'
+            | 'Australia/Hobart'
+            | 'Australia/Lindeman'
+            | 'Australia/Lord_Howe'
+            | 'Australia/Melbourne'
+            | 'Australia/Perth'
+            | 'Australia/Sydney'
+            | 'Europe/Amsterdam'
+            | 'Europe/Andorra'
+            | 'Europe/Astrakhan'
+            | 'Europe/Athens'
+            | 'Europe/Belgrade'
+            | 'Europe/Berlin'
+            | 'Europe/Bratislava'
+            | 'Europe/Brussels'
+            | 'Europe/Bucharest'
+            | 'Europe/Budapest'
+            | 'Europe/Busingen'
+            | 'Europe/Chisinau'
+            | 'Europe/Copenhagen'
+            | 'Europe/Dublin'
+            | 'Europe/Gibraltar'
+            | 'Europe/Guernsey'
+            | 'Europe/Helsinki'
+            | 'Europe/Isle_of_Man'
+            | 'Europe/Istanbul'
+            | 'Europe/Jersey'
+            | 'Europe/Kaliningrad'
+            | 'Europe/Kiev'
+            | 'Europe/Kirov'
+            | 'Europe/Lisbon'
+            | 'Europe/Ljubljana'
+            | 'Europe/London'
+            | 'Europe/Luxembourg'
+            | 'Europe/Madrid'
+            | 'Europe/Malta'
+            | 'Europe/Mariehamn'
+            | 'Europe/Minsk'
+            | 'Europe/Monaco'
+            | 'Europe/Moscow'
+            | 'Europe/Oslo'
+            | 'Europe/Paris'
+            | 'Europe/Podgorica'
+            | 'Europe/Prague'
+            | 'Europe/Riga'
+            | 'Europe/Rome'
+            | 'Europe/Samara'
+            | 'Europe/San_Marino'
+            | 'Europe/Sarajevo'
+            | 'Europe/Saratov'
+            | 'Europe/Simferopol'
+            | 'Europe/Skopje'
+            | 'Europe/Sofia'
+            | 'Europe/Stockholm'
+            | 'Europe/Tallinn'
+            | 'Europe/Tirane'
+            | 'Europe/Ulyanovsk'
+            | 'Europe/Uzhgorod'
+            | 'Europe/Vaduz'
+            | 'Europe/Vatican'
+            | 'Europe/Vienna'
+            | 'Europe/Vilnius'
+            | 'Europe/Volgograd'
+            | 'Europe/Warsaw'
+            | 'Europe/Zagreb'
+            | 'Europe/Zaporozhye'
+            | 'Europe/Zurich'
+            | 'Indian/Antananarivo'
+            | 'Indian/Chagos'
+            | 'Indian/Christmas'
+            | 'Indian/Cocos'
+            | 'Indian/Comoro'
+            | 'Indian/Kerguelen'
+            | 'Indian/Mahe'
+            | 'Indian/Maldives'
+            | 'Indian/Mauritius'
+            | 'Indian/Mayotte'
+            | 'Indian/Reunion'
+            | 'Pacific/Apia'
+            | 'Pacific/Auckland'
+            | 'Pacific/Bougainville'
+            | 'Pacific/Chatham'
+            | 'Pacific/Easter'
+            | 'Pacific/Efate'
+            | 'Pacific/Enderbury'
+            | 'Pacific/Fakaofo'
+            | 'Pacific/Fiji'
+            | 'Pacific/Funafuti'
+            | 'Pacific/Galapagos'
+            | 'Pacific/Gambier'
+            | 'Pacific/Guadalcanal'
+            | 'Pacific/Guam'
+            | 'Pacific/Honolulu'
+            | 'Pacific/Johnston'
+            | 'Pacific/Kiritimati'
+            | 'Pacific/Kosrae'
+            | 'Pacific/Kwajalein'
+            | 'Pacific/Majuro'
+            | 'Pacific/Marquesas'
+            | 'Pacific/Midway'
+            | 'Pacific/Nauru'
+            | 'Pacific/Niue'
+            | 'Pacific/Norfolk'
+            | 'Pacific/Noumea'
+            | 'Pacific/Pago_Pago'
+            | 'Pacific/Palau'
+            | 'Pacific/Pitcairn'
+            | 'Pacific/Ponape'
+            | 'Pacific/Port_Moresby'
+            | 'Pacific/Rarotonga'
+            | 'Pacific/Saipan'
+            | 'Pacific/Tahiti'
+            | 'Pacific/Tarawa'
+            | 'Pacific/Tongatapu'
+            | 'Pacific/Truk'
+            | 'Pacific/Wake'
+            | 'Pacific/Wallis'
+            | undefined
+        }
+      | undefined
+    /**
+     * Schlage-specific metadata to update
+     */
+    schlage_metadata?:
+      | {
+          /**
+           * IANA timezone for the Schlage device
+           */
+          time_zone?:
+            | 'Africa/Abidjan'
+            | 'Africa/Accra'
+            | 'Africa/Addis_Ababa'
+            | 'Africa/Algiers'
+            | 'Africa/Asmera'
+            | 'Africa/Bamako'
+            | 'Africa/Bangui'
+            | 'Africa/Banjul'
+            | 'Africa/Bissau'
+            | 'Africa/Blantyre'
+            | 'Africa/Brazzaville'
+            | 'Africa/Bujumbura'
+            | 'Africa/Cairo'
+            | 'Africa/Casablanca'
+            | 'Africa/Ceuta'
+            | 'Africa/Conakry'
+            | 'Africa/Dakar'
+            | 'Africa/Dar_es_Salaam'
+            | 'Africa/Djibouti'
+            | 'Africa/Douala'
+            | 'Africa/El_Aaiun'
+            | 'Africa/Freetown'
+            | 'Africa/Gaborone'
+            | 'Africa/Harare'
+            | 'Africa/Johannesburg'
+            | 'Africa/Juba'
+            | 'Africa/Kampala'
+            | 'Africa/Khartoum'
+            | 'Africa/Kigali'
+            | 'Africa/Kinshasa'
+            | 'Africa/Lagos'
+            | 'Africa/Libreville'
+            | 'Africa/Lome'
+            | 'Africa/Luanda'
+            | 'Africa/Lubumbashi'
+            | 'Africa/Lusaka'
+            | 'Africa/Malabo'
+            | 'Africa/Maputo'
+            | 'Africa/Maseru'
+            | 'Africa/Mbabane'
+            | 'Africa/Mogadishu'
+            | 'Africa/Monrovia'
+            | 'Africa/Nairobi'
+            | 'Africa/Ndjamena'
+            | 'Africa/Niamey'
+            | 'Africa/Nouakchott'
+            | 'Africa/Ouagadougou'
+            | 'Africa/Porto-Novo'
+            | 'Africa/Sao_Tome'
+            | 'Africa/Tripoli'
+            | 'Africa/Tunis'
+            | 'Africa/Windhoek'
+            | 'America/Adak'
+            | 'America/Anchorage'
+            | 'America/Anguilla'
+            | 'America/Antigua'
+            | 'America/Araguaina'
+            | 'America/Argentina/La_Rioja'
+            | 'America/Argentina/Rio_Gallegos'
+            | 'America/Argentina/Salta'
+            | 'America/Argentina/San_Juan'
+            | 'America/Argentina/San_Luis'
+            | 'America/Argentina/Tucuman'
+            | 'America/Argentina/Ushuaia'
+            | 'America/Aruba'
+            | 'America/Asuncion'
+            | 'America/Bahia'
+            | 'America/Bahia_Banderas'
+            | 'America/Barbados'
+            | 'America/Belem'
+            | 'America/Belize'
+            | 'America/Blanc-Sablon'
+            | 'America/Boa_Vista'
+            | 'America/Bogota'
+            | 'America/Boise'
+            | 'America/Buenos_Aires'
+            | 'America/Cambridge_Bay'
+            | 'America/Campo_Grande'
+            | 'America/Cancun'
+            | 'America/Caracas'
+            | 'America/Catamarca'
+            | 'America/Cayenne'
+            | 'America/Cayman'
+            | 'America/Chicago'
+            | 'America/Chihuahua'
+            | 'America/Ciudad_Juarez'
+            | 'America/Coral_Harbour'
+            | 'America/Cordoba'
+            | 'America/Costa_Rica'
+            | 'America/Creston'
+            | 'America/Cuiaba'
+            | 'America/Curacao'
+            | 'America/Danmarkshavn'
+            | 'America/Dawson'
+            | 'America/Dawson_Creek'
+            | 'America/Denver'
+            | 'America/Detroit'
+            | 'America/Dominica'
+            | 'America/Edmonton'
+            | 'America/Eirunepe'
+            | 'America/El_Salvador'
+            | 'America/Fort_Nelson'
+            | 'America/Fortaleza'
+            | 'America/Glace_Bay'
+            | 'America/Godthab'
+            | 'America/Goose_Bay'
+            | 'America/Grand_Turk'
+            | 'America/Grenada'
+            | 'America/Guadeloupe'
+            | 'America/Guatemala'
+            | 'America/Guayaquil'
+            | 'America/Guyana'
+            | 'America/Halifax'
+            | 'America/Havana'
+            | 'America/Hermosillo'
+            | 'America/Indiana/Knox'
+            | 'America/Indiana/Marengo'
+            | 'America/Indiana/Petersburg'
+            | 'America/Indiana/Tell_City'
+            | 'America/Indiana/Vevay'
+            | 'America/Indiana/Vincennes'
+            | 'America/Indiana/Winamac'
+            | 'America/Indianapolis'
+            | 'America/Inuvik'
+            | 'America/Iqaluit'
+            | 'America/Jamaica'
+            | 'America/Jujuy'
+            | 'America/Juneau'
+            | 'America/Kentucky/Monticello'
+            | 'America/Kralendijk'
+            | 'America/La_Paz'
+            | 'America/Lima'
+            | 'America/Los_Angeles'
+            | 'America/Louisville'
+            | 'America/Lower_Princes'
+            | 'America/Maceio'
+            | 'America/Managua'
+            | 'America/Manaus'
+            | 'America/Marigot'
+            | 'America/Martinique'
+            | 'America/Matamoros'
+            | 'America/Mazatlan'
+            | 'America/Mendoza'
+            | 'America/Menominee'
+            | 'America/Merida'
+            | 'America/Metlakatla'
+            | 'America/Mexico_City'
+            | 'America/Miquelon'
+            | 'America/Moncton'
+            | 'America/Monterrey'
+            | 'America/Montevideo'
+            | 'America/Montreal'
+            | 'America/Montserrat'
+            | 'America/Nassau'
+            | 'America/New_York'
+            | 'America/Nipigon'
+            | 'America/Nome'
+            | 'America/Noronha'
+            | 'America/North_Dakota/Beulah'
+            | 'America/North_Dakota/Center'
+            | 'America/North_Dakota/New_Salem'
+            | 'America/Ojinaga'
+            | 'America/Panama'
+            | 'America/Pangnirtung'
+            | 'America/Paramaribo'
+            | 'America/Phoenix'
+            | 'America/Port-au-Prince'
+            | 'America/Port_of_Spain'
+            | 'America/Porto_Velho'
+            | 'America/Puerto_Rico'
+            | 'America/Punta_Arenas'
+            | 'America/Rainy_River'
+            | 'America/Rankin_Inlet'
+            | 'America/Recife'
+            | 'America/Regina'
+            | 'America/Resolute'
+            | 'America/Rio_Branco'
+            | 'America/Santa_Isabel'
+            | 'America/Santarem'
+            | 'America/Santiago'
+            | 'America/Santo_Domingo'
+            | 'America/Sao_Paulo'
+            | 'America/Scoresbysund'
+            | 'America/Sitka'
+            | 'America/St_Barthelemy'
+            | 'America/St_Johns'
+            | 'America/St_Kitts'
+            | 'America/St_Lucia'
+            | 'America/St_Thomas'
+            | 'America/St_Vincent'
+            | 'America/Swift_Current'
+            | 'America/Tegucigalpa'
+            | 'America/Thule'
+            | 'America/Thunder_Bay'
+            | 'America/Tijuana'
+            | 'America/Toronto'
+            | 'America/Tortola'
+            | 'America/Vancouver'
+            | 'America/Whitehorse'
+            | 'America/Winnipeg'
+            | 'America/Yakutat'
+            | 'America/Yellowknife'
+            | 'Antarctica/Casey'
+            | 'Antarctica/Davis'
+            | 'Antarctica/DumontDUrville'
+            | 'Antarctica/Macquarie'
+            | 'Antarctica/Mawson'
+            | 'Antarctica/McMurdo'
+            | 'Antarctica/Palmer'
+            | 'Antarctica/Rothera'
+            | 'Antarctica/Syowa'
+            | 'Antarctica/Troll'
+            | 'Antarctica/Vostok'
+            | 'Arctic/Longyearbyen'
+            | 'Asia/Aden'
+            | 'Asia/Almaty'
+            | 'Asia/Amman'
+            | 'Asia/Anadyr'
+            | 'Asia/Aqtau'
+            | 'Asia/Aqtobe'
+            | 'Asia/Ashgabat'
+            | 'Asia/Atyrau'
+            | 'Asia/Baghdad'
+            | 'Asia/Bahrain'
+            | 'Asia/Baku'
+            | 'Asia/Bangkok'
+            | 'Asia/Barnaul'
+            | 'Asia/Beirut'
+            | 'Asia/Bishkek'
+            | 'Asia/Brunei'
+            | 'Asia/Calcutta'
+            | 'Asia/Chita'
+            | 'Asia/Choibalsan'
+            | 'Asia/Colombo'
+            | 'Asia/Damascus'
+            | 'Asia/Dhaka'
+            | 'Asia/Dili'
+            | 'Asia/Dubai'
+            | 'Asia/Dushanbe'
+            | 'Asia/Famagusta'
+            | 'Asia/Gaza'
+            | 'Asia/Hebron'
+            | 'Asia/Hong_Kong'
+            | 'Asia/Hovd'
+            | 'Asia/Irkutsk'
+            | 'Asia/Jakarta'
+            | 'Asia/Jayapura'
+            | 'Asia/Jerusalem'
+            | 'Asia/Kabul'
+            | 'Asia/Kamchatka'
+            | 'Asia/Karachi'
+            | 'Asia/Katmandu'
+            | 'Asia/Khandyga'
+            | 'Asia/Krasnoyarsk'
+            | 'Asia/Kuala_Lumpur'
+            | 'Asia/Kuching'
+            | 'Asia/Kuwait'
+            | 'Asia/Macau'
+            | 'Asia/Magadan'
+            | 'Asia/Makassar'
+            | 'Asia/Manila'
+            | 'Asia/Muscat'
+            | 'Asia/Nicosia'
+            | 'Asia/Novokuznetsk'
+            | 'Asia/Novosibirsk'
+            | 'Asia/Omsk'
+            | 'Asia/Oral'
+            | 'Asia/Phnom_Penh'
+            | 'Asia/Pontianak'
+            | 'Asia/Pyongyang'
+            | 'Asia/Qatar'
+            | 'Asia/Qostanay'
+            | 'Asia/Qyzylorda'
+            | 'Asia/Rangoon'
+            | 'Asia/Riyadh'
+            | 'Asia/Saigon'
+            | 'Asia/Sakhalin'
+            | 'Asia/Samarkand'
+            | 'Asia/Seoul'
+            | 'Asia/Shanghai'
+            | 'Asia/Singapore'
+            | 'Asia/Srednekolymsk'
+            | 'Asia/Taipei'
+            | 'Asia/Tashkent'
+            | 'Asia/Tbilisi'
+            | 'Asia/Tehran'
+            | 'Asia/Thimphu'
+            | 'Asia/Tokyo'
+            | 'Asia/Tomsk'
+            | 'Asia/Ulaanbaatar'
+            | 'Asia/Urumqi'
+            | 'Asia/Ust-Nera'
+            | 'Asia/Vientiane'
+            | 'Asia/Vladivostok'
+            | 'Asia/Yakutsk'
+            | 'Asia/Yekaterinburg'
+            | 'Asia/Yerevan'
+            | 'Atlantic/Azores'
+            | 'Atlantic/Bermuda'
+            | 'Atlantic/Canary'
+            | 'Atlantic/Cape_Verde'
+            | 'Atlantic/Faeroe'
+            | 'Atlantic/Madeira'
+            | 'Atlantic/Reykjavik'
+            | 'Atlantic/South_Georgia'
+            | 'Atlantic/St_Helena'
+            | 'Atlantic/Stanley'
+            | 'Australia/Adelaide'
+            | 'Australia/Brisbane'
+            | 'Australia/Broken_Hill'
+            | 'Australia/Currie'
+            | 'Australia/Darwin'
+            | 'Australia/Eucla'
+            | 'Australia/Hobart'
+            | 'Australia/Lindeman'
+            | 'Australia/Lord_Howe'
+            | 'Australia/Melbourne'
+            | 'Australia/Perth'
+            | 'Australia/Sydney'
+            | 'Europe/Amsterdam'
+            | 'Europe/Andorra'
+            | 'Europe/Astrakhan'
+            | 'Europe/Athens'
+            | 'Europe/Belgrade'
+            | 'Europe/Berlin'
+            | 'Europe/Bratislava'
+            | 'Europe/Brussels'
+            | 'Europe/Bucharest'
+            | 'Europe/Budapest'
+            | 'Europe/Busingen'
+            | 'Europe/Chisinau'
+            | 'Europe/Copenhagen'
+            | 'Europe/Dublin'
+            | 'Europe/Gibraltar'
+            | 'Europe/Guernsey'
+            | 'Europe/Helsinki'
+            | 'Europe/Isle_of_Man'
+            | 'Europe/Istanbul'
+            | 'Europe/Jersey'
+            | 'Europe/Kaliningrad'
+            | 'Europe/Kiev'
+            | 'Europe/Kirov'
+            | 'Europe/Lisbon'
+            | 'Europe/Ljubljana'
+            | 'Europe/London'
+            | 'Europe/Luxembourg'
+            | 'Europe/Madrid'
+            | 'Europe/Malta'
+            | 'Europe/Mariehamn'
+            | 'Europe/Minsk'
+            | 'Europe/Monaco'
+            | 'Europe/Moscow'
+            | 'Europe/Oslo'
+            | 'Europe/Paris'
+            | 'Europe/Podgorica'
+            | 'Europe/Prague'
+            | 'Europe/Riga'
+            | 'Europe/Rome'
+            | 'Europe/Samara'
+            | 'Europe/San_Marino'
+            | 'Europe/Sarajevo'
+            | 'Europe/Saratov'
+            | 'Europe/Simferopol'
+            | 'Europe/Skopje'
+            | 'Europe/Sofia'
+            | 'Europe/Stockholm'
+            | 'Europe/Tallinn'
+            | 'Europe/Tirane'
+            | 'Europe/Ulyanovsk'
+            | 'Europe/Uzhgorod'
+            | 'Europe/Vaduz'
+            | 'Europe/Vatican'
+            | 'Europe/Vienna'
+            | 'Europe/Vilnius'
+            | 'Europe/Volgograd'
+            | 'Europe/Warsaw'
+            | 'Europe/Zagreb'
+            | 'Europe/Zaporozhye'
+            | 'Europe/Zurich'
+            | 'Indian/Antananarivo'
+            | 'Indian/Chagos'
+            | 'Indian/Christmas'
+            | 'Indian/Cocos'
+            | 'Indian/Comoro'
+            | 'Indian/Kerguelen'
+            | 'Indian/Mahe'
+            | 'Indian/Maldives'
+            | 'Indian/Mauritius'
+            | 'Indian/Mayotte'
+            | 'Indian/Reunion'
+            | 'Pacific/Apia'
+            | 'Pacific/Auckland'
+            | 'Pacific/Bougainville'
+            | 'Pacific/Chatham'
+            | 'Pacific/Easter'
+            | 'Pacific/Efate'
+            | 'Pacific/Enderbury'
+            | 'Pacific/Fakaofo'
+            | 'Pacific/Fiji'
+            | 'Pacific/Funafuti'
+            | 'Pacific/Galapagos'
+            | 'Pacific/Gambier'
+            | 'Pacific/Guadalcanal'
+            | 'Pacific/Guam'
+            | 'Pacific/Honolulu'
+            | 'Pacific/Johnston'
+            | 'Pacific/Kiritimati'
+            | 'Pacific/Kosrae'
+            | 'Pacific/Kwajalein'
+            | 'Pacific/Majuro'
+            | 'Pacific/Marquesas'
+            | 'Pacific/Midway'
+            | 'Pacific/Nauru'
+            | 'Pacific/Niue'
+            | 'Pacific/Norfolk'
+            | 'Pacific/Noumea'
+            | 'Pacific/Pago_Pago'
+            | 'Pacific/Palau'
+            | 'Pacific/Pitcairn'
+            | 'Pacific/Ponape'
+            | 'Pacific/Port_Moresby'
+            | 'Pacific/Rarotonga'
+            | 'Pacific/Saipan'
+            | 'Pacific/Tahiti'
+            | 'Pacific/Tarawa'
+            | 'Pacific/Tongatapu'
+            | 'Pacific/Truk'
+            | 'Pacific/Wake'
+            | 'Pacific/Wallis'
+            | undefined
+        }
+      | undefined
+    /**
+     * Ultraloq-specific metadata to update
+     */
+    ultraloq_metadata?:
+      | {
+          /**
+           * IANA timezone for the Ultraloq device
+           */
+          time_zone?:
+            | 'Africa/Abidjan'
+            | 'Africa/Accra'
+            | 'Africa/Addis_Ababa'
+            | 'Africa/Algiers'
+            | 'Africa/Asmera'
+            | 'Africa/Bamako'
+            | 'Africa/Bangui'
+            | 'Africa/Banjul'
+            | 'Africa/Bissau'
+            | 'Africa/Blantyre'
+            | 'Africa/Brazzaville'
+            | 'Africa/Bujumbura'
+            | 'Africa/Cairo'
+            | 'Africa/Casablanca'
+            | 'Africa/Ceuta'
+            | 'Africa/Conakry'
+            | 'Africa/Dakar'
+            | 'Africa/Dar_es_Salaam'
+            | 'Africa/Djibouti'
+            | 'Africa/Douala'
+            | 'Africa/El_Aaiun'
+            | 'Africa/Freetown'
+            | 'Africa/Gaborone'
+            | 'Africa/Harare'
+            | 'Africa/Johannesburg'
+            | 'Africa/Juba'
+            | 'Africa/Kampala'
+            | 'Africa/Khartoum'
+            | 'Africa/Kigali'
+            | 'Africa/Kinshasa'
+            | 'Africa/Lagos'
+            | 'Africa/Libreville'
+            | 'Africa/Lome'
+            | 'Africa/Luanda'
+            | 'Africa/Lubumbashi'
+            | 'Africa/Lusaka'
+            | 'Africa/Malabo'
+            | 'Africa/Maputo'
+            | 'Africa/Maseru'
+            | 'Africa/Mbabane'
+            | 'Africa/Mogadishu'
+            | 'Africa/Monrovia'
+            | 'Africa/Nairobi'
+            | 'Africa/Ndjamena'
+            | 'Africa/Niamey'
+            | 'Africa/Nouakchott'
+            | 'Africa/Ouagadougou'
+            | 'Africa/Porto-Novo'
+            | 'Africa/Sao_Tome'
+            | 'Africa/Tripoli'
+            | 'Africa/Tunis'
+            | 'Africa/Windhoek'
+            | 'America/Adak'
+            | 'America/Anchorage'
+            | 'America/Anguilla'
+            | 'America/Antigua'
+            | 'America/Araguaina'
+            | 'America/Argentina/La_Rioja'
+            | 'America/Argentina/Rio_Gallegos'
+            | 'America/Argentina/Salta'
+            | 'America/Argentina/San_Juan'
+            | 'America/Argentina/San_Luis'
+            | 'America/Argentina/Tucuman'
+            | 'America/Argentina/Ushuaia'
+            | 'America/Aruba'
+            | 'America/Asuncion'
+            | 'America/Bahia'
+            | 'America/Bahia_Banderas'
+            | 'America/Barbados'
+            | 'America/Belem'
+            | 'America/Belize'
+            | 'America/Blanc-Sablon'
+            | 'America/Boa_Vista'
+            | 'America/Bogota'
+            | 'America/Boise'
+            | 'America/Buenos_Aires'
+            | 'America/Cambridge_Bay'
+            | 'America/Campo_Grande'
+            | 'America/Cancun'
+            | 'America/Caracas'
+            | 'America/Catamarca'
+            | 'America/Cayenne'
+            | 'America/Cayman'
+            | 'America/Chicago'
+            | 'America/Chihuahua'
+            | 'America/Ciudad_Juarez'
+            | 'America/Coral_Harbour'
+            | 'America/Cordoba'
+            | 'America/Costa_Rica'
+            | 'America/Creston'
+            | 'America/Cuiaba'
+            | 'America/Curacao'
+            | 'America/Danmarkshavn'
+            | 'America/Dawson'
+            | 'America/Dawson_Creek'
+            | 'America/Denver'
+            | 'America/Detroit'
+            | 'America/Dominica'
+            | 'America/Edmonton'
+            | 'America/Eirunepe'
+            | 'America/El_Salvador'
+            | 'America/Fort_Nelson'
+            | 'America/Fortaleza'
+            | 'America/Glace_Bay'
+            | 'America/Godthab'
+            | 'America/Goose_Bay'
+            | 'America/Grand_Turk'
+            | 'America/Grenada'
+            | 'America/Guadeloupe'
+            | 'America/Guatemala'
+            | 'America/Guayaquil'
+            | 'America/Guyana'
+            | 'America/Halifax'
+            | 'America/Havana'
+            | 'America/Hermosillo'
+            | 'America/Indiana/Knox'
+            | 'America/Indiana/Marengo'
+            | 'America/Indiana/Petersburg'
+            | 'America/Indiana/Tell_City'
+            | 'America/Indiana/Vevay'
+            | 'America/Indiana/Vincennes'
+            | 'America/Indiana/Winamac'
+            | 'America/Indianapolis'
+            | 'America/Inuvik'
+            | 'America/Iqaluit'
+            | 'America/Jamaica'
+            | 'America/Jujuy'
+            | 'America/Juneau'
+            | 'America/Kentucky/Monticello'
+            | 'America/Kralendijk'
+            | 'America/La_Paz'
+            | 'America/Lima'
+            | 'America/Los_Angeles'
+            | 'America/Louisville'
+            | 'America/Lower_Princes'
+            | 'America/Maceio'
+            | 'America/Managua'
+            | 'America/Manaus'
+            | 'America/Marigot'
+            | 'America/Martinique'
+            | 'America/Matamoros'
+            | 'America/Mazatlan'
+            | 'America/Mendoza'
+            | 'America/Menominee'
+            | 'America/Merida'
+            | 'America/Metlakatla'
+            | 'America/Mexico_City'
+            | 'America/Miquelon'
+            | 'America/Moncton'
+            | 'America/Monterrey'
+            | 'America/Montevideo'
+            | 'America/Montreal'
+            | 'America/Montserrat'
+            | 'America/Nassau'
+            | 'America/New_York'
+            | 'America/Nipigon'
+            | 'America/Nome'
+            | 'America/Noronha'
+            | 'America/North_Dakota/Beulah'
+            | 'America/North_Dakota/Center'
+            | 'America/North_Dakota/New_Salem'
+            | 'America/Ojinaga'
+            | 'America/Panama'
+            | 'America/Pangnirtung'
+            | 'America/Paramaribo'
+            | 'America/Phoenix'
+            | 'America/Port-au-Prince'
+            | 'America/Port_of_Spain'
+            | 'America/Porto_Velho'
+            | 'America/Puerto_Rico'
+            | 'America/Punta_Arenas'
+            | 'America/Rainy_River'
+            | 'America/Rankin_Inlet'
+            | 'America/Recife'
+            | 'America/Regina'
+            | 'America/Resolute'
+            | 'America/Rio_Branco'
+            | 'America/Santa_Isabel'
+            | 'America/Santarem'
+            | 'America/Santiago'
+            | 'America/Santo_Domingo'
+            | 'America/Sao_Paulo'
+            | 'America/Scoresbysund'
+            | 'America/Sitka'
+            | 'America/St_Barthelemy'
+            | 'America/St_Johns'
+            | 'America/St_Kitts'
+            | 'America/St_Lucia'
+            | 'America/St_Thomas'
+            | 'America/St_Vincent'
+            | 'America/Swift_Current'
+            | 'America/Tegucigalpa'
+            | 'America/Thule'
+            | 'America/Thunder_Bay'
+            | 'America/Tijuana'
+            | 'America/Toronto'
+            | 'America/Tortola'
+            | 'America/Vancouver'
+            | 'America/Whitehorse'
+            | 'America/Winnipeg'
+            | 'America/Yakutat'
+            | 'America/Yellowknife'
+            | 'Antarctica/Casey'
+            | 'Antarctica/Davis'
+            | 'Antarctica/DumontDUrville'
+            | 'Antarctica/Macquarie'
+            | 'Antarctica/Mawson'
+            | 'Antarctica/McMurdo'
+            | 'Antarctica/Palmer'
+            | 'Antarctica/Rothera'
+            | 'Antarctica/Syowa'
+            | 'Antarctica/Troll'
+            | 'Antarctica/Vostok'
+            | 'Arctic/Longyearbyen'
+            | 'Asia/Aden'
+            | 'Asia/Almaty'
+            | 'Asia/Amman'
+            | 'Asia/Anadyr'
+            | 'Asia/Aqtau'
+            | 'Asia/Aqtobe'
+            | 'Asia/Ashgabat'
+            | 'Asia/Atyrau'
+            | 'Asia/Baghdad'
+            | 'Asia/Bahrain'
+            | 'Asia/Baku'
+            | 'Asia/Bangkok'
+            | 'Asia/Barnaul'
+            | 'Asia/Beirut'
+            | 'Asia/Bishkek'
+            | 'Asia/Brunei'
+            | 'Asia/Calcutta'
+            | 'Asia/Chita'
+            | 'Asia/Choibalsan'
+            | 'Asia/Colombo'
+            | 'Asia/Damascus'
+            | 'Asia/Dhaka'
+            | 'Asia/Dili'
+            | 'Asia/Dubai'
+            | 'Asia/Dushanbe'
+            | 'Asia/Famagusta'
+            | 'Asia/Gaza'
+            | 'Asia/Hebron'
+            | 'Asia/Hong_Kong'
+            | 'Asia/Hovd'
+            | 'Asia/Irkutsk'
+            | 'Asia/Jakarta'
+            | 'Asia/Jayapura'
+            | 'Asia/Jerusalem'
+            | 'Asia/Kabul'
+            | 'Asia/Kamchatka'
+            | 'Asia/Karachi'
+            | 'Asia/Katmandu'
+            | 'Asia/Khandyga'
+            | 'Asia/Krasnoyarsk'
+            | 'Asia/Kuala_Lumpur'
+            | 'Asia/Kuching'
+            | 'Asia/Kuwait'
+            | 'Asia/Macau'
+            | 'Asia/Magadan'
+            | 'Asia/Makassar'
+            | 'Asia/Manila'
+            | 'Asia/Muscat'
+            | 'Asia/Nicosia'
+            | 'Asia/Novokuznetsk'
+            | 'Asia/Novosibirsk'
+            | 'Asia/Omsk'
+            | 'Asia/Oral'
+            | 'Asia/Phnom_Penh'
+            | 'Asia/Pontianak'
+            | 'Asia/Pyongyang'
+            | 'Asia/Qatar'
+            | 'Asia/Qostanay'
+            | 'Asia/Qyzylorda'
+            | 'Asia/Rangoon'
+            | 'Asia/Riyadh'
+            | 'Asia/Saigon'
+            | 'Asia/Sakhalin'
+            | 'Asia/Samarkand'
+            | 'Asia/Seoul'
+            | 'Asia/Shanghai'
+            | 'Asia/Singapore'
+            | 'Asia/Srednekolymsk'
+            | 'Asia/Taipei'
+            | 'Asia/Tashkent'
+            | 'Asia/Tbilisi'
+            | 'Asia/Tehran'
+            | 'Asia/Thimphu'
+            | 'Asia/Tokyo'
+            | 'Asia/Tomsk'
+            | 'Asia/Ulaanbaatar'
+            | 'Asia/Urumqi'
+            | 'Asia/Ust-Nera'
+            | 'Asia/Vientiane'
+            | 'Asia/Vladivostok'
+            | 'Asia/Yakutsk'
+            | 'Asia/Yekaterinburg'
+            | 'Asia/Yerevan'
+            | 'Atlantic/Azores'
+            | 'Atlantic/Bermuda'
+            | 'Atlantic/Canary'
+            | 'Atlantic/Cape_Verde'
+            | 'Atlantic/Faeroe'
+            | 'Atlantic/Madeira'
+            | 'Atlantic/Reykjavik'
+            | 'Atlantic/South_Georgia'
+            | 'Atlantic/St_Helena'
+            | 'Atlantic/Stanley'
+            | 'Australia/Adelaide'
+            | 'Australia/Brisbane'
+            | 'Australia/Broken_Hill'
+            | 'Australia/Currie'
+            | 'Australia/Darwin'
+            | 'Australia/Eucla'
+            | 'Australia/Hobart'
+            | 'Australia/Lindeman'
+            | 'Australia/Lord_Howe'
+            | 'Australia/Melbourne'
+            | 'Australia/Perth'
+            | 'Australia/Sydney'
+            | 'Europe/Amsterdam'
+            | 'Europe/Andorra'
+            | 'Europe/Astrakhan'
+            | 'Europe/Athens'
+            | 'Europe/Belgrade'
+            | 'Europe/Berlin'
+            | 'Europe/Bratislava'
+            | 'Europe/Brussels'
+            | 'Europe/Bucharest'
+            | 'Europe/Budapest'
+            | 'Europe/Busingen'
+            | 'Europe/Chisinau'
+            | 'Europe/Copenhagen'
+            | 'Europe/Dublin'
+            | 'Europe/Gibraltar'
+            | 'Europe/Guernsey'
+            | 'Europe/Helsinki'
+            | 'Europe/Isle_of_Man'
+            | 'Europe/Istanbul'
+            | 'Europe/Jersey'
+            | 'Europe/Kaliningrad'
+            | 'Europe/Kiev'
+            | 'Europe/Kirov'
+            | 'Europe/Lisbon'
+            | 'Europe/Ljubljana'
+            | 'Europe/London'
+            | 'Europe/Luxembourg'
+            | 'Europe/Madrid'
+            | 'Europe/Malta'
+            | 'Europe/Mariehamn'
+            | 'Europe/Minsk'
+            | 'Europe/Monaco'
+            | 'Europe/Moscow'
+            | 'Europe/Oslo'
+            | 'Europe/Paris'
+            | 'Europe/Podgorica'
+            | 'Europe/Prague'
+            | 'Europe/Riga'
+            | 'Europe/Rome'
+            | 'Europe/Samara'
+            | 'Europe/San_Marino'
+            | 'Europe/Sarajevo'
+            | 'Europe/Saratov'
+            | 'Europe/Simferopol'
+            | 'Europe/Skopje'
+            | 'Europe/Sofia'
+            | 'Europe/Stockholm'
+            | 'Europe/Tallinn'
+            | 'Europe/Tirane'
+            | 'Europe/Ulyanovsk'
+            | 'Europe/Uzhgorod'
+            | 'Europe/Vaduz'
+            | 'Europe/Vatican'
+            | 'Europe/Vienna'
+            | 'Europe/Vilnius'
+            | 'Europe/Volgograd'
+            | 'Europe/Warsaw'
+            | 'Europe/Zagreb'
+            | 'Europe/Zaporozhye'
+            | 'Europe/Zurich'
+            | 'Indian/Antananarivo'
+            | 'Indian/Chagos'
+            | 'Indian/Christmas'
+            | 'Indian/Cocos'
+            | 'Indian/Comoro'
+            | 'Indian/Kerguelen'
+            | 'Indian/Mahe'
+            | 'Indian/Maldives'
+            | 'Indian/Mauritius'
+            | 'Indian/Mayotte'
+            | 'Indian/Reunion'
+            | 'Pacific/Apia'
+            | 'Pacific/Auckland'
+            | 'Pacific/Bougainville'
+            | 'Pacific/Chatham'
+            | 'Pacific/Easter'
+            | 'Pacific/Efate'
+            | 'Pacific/Enderbury'
+            | 'Pacific/Fakaofo'
+            | 'Pacific/Fiji'
+            | 'Pacific/Funafuti'
+            | 'Pacific/Galapagos'
+            | 'Pacific/Gambier'
+            | 'Pacific/Guadalcanal'
+            | 'Pacific/Guam'
+            | 'Pacific/Honolulu'
+            | 'Pacific/Johnston'
+            | 'Pacific/Kiritimati'
+            | 'Pacific/Kosrae'
+            | 'Pacific/Kwajalein'
+            | 'Pacific/Majuro'
+            | 'Pacific/Marquesas'
+            | 'Pacific/Midway'
+            | 'Pacific/Nauru'
+            | 'Pacific/Niue'
+            | 'Pacific/Norfolk'
+            | 'Pacific/Noumea'
+            | 'Pacific/Pago_Pago'
+            | 'Pacific/Palau'
+            | 'Pacific/Pitcairn'
+            | 'Pacific/Ponape'
+            | 'Pacific/Port_Moresby'
+            | 'Pacific/Rarotonga'
+            | 'Pacific/Saipan'
+            | 'Pacific/Tahiti'
+            | 'Pacific/Tarawa'
+            | 'Pacific/Tongatapu'
+            | 'Pacific/Truk'
+            | 'Pacific/Wake'
+            | 'Pacific/Wallis'
+            | undefined
+        }
+      | undefined
+  }>
+}
+
+/**
+ * @deprecated Use DevicesReportProviderMetadataRequest instead.
+ */
+export type DevicesReportProviderMetadataResponse = void
+
+export type DevicesReportProviderMetadataRequest = SeamHttpRequest<
+  void,
+  undefined
+>
+
+export interface DevicesReportProviderMetadataOptions {}
+
+export type DevicesUpdateParameters = {
+  /**
+   * Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.
+   */
+  backup_access_code_pool_enabled?: boolean | undefined
+  /**
+   * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
+   */
+  custom_metadata?: Record<string, unknown> | undefined
+  /**
+   * ID of the device that you want to update.
+   */
+  device_id: string
+
+  /**
+   * Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.
+   */
+  is_managed?: boolean | undefined
+  /**
+   * Name for the device.
+   */
+  name?: string | undefined
+
+  properties?:
+    | {
+        /**
+         * Name for the device.
+         */
+        name?: string | undefined
+      }
+    | undefined
+}
+
+/**
+ * @deprecated Use DevicesUpdateRequest instead.
+ */
+export type DevicesUpdateResponse = void
+
+export type DevicesUpdateRequest = SeamHttpRequest<void, undefined>
+
+export interface DevicesUpdateOptions {}