Class SeamHttpDevices

constructor

• new SeamHttpDevices(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttpDevices

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevices

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpDevicesSimulate

  Returns SeamHttpDevicesSimulate

unmanaged

• get unmanaged(): SeamHttpDevicesUnmanaged

  Returns SeamHttpDevicesUnmanaged

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters?: { device_id: string },
      options?: DevicesDeleteOptions,
  ): DevicesDeleteRequest

  Parameters

  • Optionalparameters: { device_id: string }

    • device_id: string

      ID of the device that you want to delete.

  • options: DevicesDeleteOptions = {}

  Returns DevicesDeleteRequest

get

• get(
      parameters?: { device_id?: string; name?: string },
      options?: DevicesGetOptions,
  ): DevicesGetRequest

  Parameters

  • Optionalparameters: { device_id?: string; name?: string }

    • Optionaldevice_id?: string

      ID of the device that you want to get.

    • Optionalname?: string

      Name of the device that you want to get.

  • options: DevicesGetOptions = {}

  Returns DevicesGetRequest

list

• list(
      parameters?: {
          connect_webview_id?: string;
          connected_account_id?: string;
          connected_account_ids?: string[];
          created_before?: Date;
          custom_metadata_has?: { [x: string]: string | boolean };
          customer_key?: string;
          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"
              | "tedee_lock"
              | "akiles_lock"
              | "ultraloq_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";
          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"
              | "tedee_lock"
              | "akiles_lock"
              | "ultraloq_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"
          )[];
          exclude_if?: (
              | "can_remotely_unlock"
              | "can_remotely_lock"
              | "can_program_offline_access_codes"
              | "can_program_online_access_codes"
              | "can_hvac_heat"
              | "can_hvac_cool"
              | "can_hvac_heat_cool"
              | "can_turn_off_hvac"
              | "can_simulate_removal"
              | "can_simulate_connection"
              | "can_simulate_disconnection"
              | "can_unlock_with_code"
              | "can_run_thermostat_programs"
              | "can_program_thermostat_programs_as_weekday_weekend"
              | "can_program_thermostat_programs_as_different_each_day"
              | "can_program_thermostat_programs_as_same_each_day"
              | "can_simulate_hub_connection"
              | "can_simulate_hub_disconnection"
              | "can_simulate_paid_subscription"
          )[];
          include_if?: (
              | "can_remotely_unlock"
              | "can_remotely_lock"
              | "can_program_offline_access_codes"
              | "can_program_online_access_codes"
              | "can_hvac_heat"
              | "can_hvac_cool"
              | "can_hvac_heat_cool"
              | "can_turn_off_hvac"
              | "can_simulate_removal"
              | "can_simulate_connection"
              | "can_simulate_disconnection"
              | "can_unlock_with_code"
              | "can_run_thermostat_programs"
              | "can_program_thermostat_programs_as_weekday_weekend"
              | "can_program_thermostat_programs_as_different_each_day"
              | "can_program_thermostat_programs_as_same_each_day"
              | "can_simulate_hub_connection"
              | "can_simulate_hub_disconnection"
              | "can_simulate_paid_subscription"
          )[];
          limit?: number;
          manufacturer?: | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "schlage"
          | "smartthings"
          | "yale"
          | "genie"
          | "doorking"
          | "salto"
          | "lockly"
          | "ttlock"
          | "linear"
          | "noiseaware"
          | "nuki"
          | "igloo"
          | "kwikset"
          | "minut"
          | "controlbyweb"
          | "nest"
          | "igloohome"
          | "ecobee"
          | "hubitat"
          | "four_suites"
          | "dormakaba_oracode"
          | "wyze"
          | "tedee"
          | "honeywell_resideo"
          | "akiles"
          | "tado"
          | "sensi"
          | "kwikset2"
          | "keynest"
          | "ultraloq"
          | "keywe"
          | "philia"
          | "samsung"
          | "seam"
          | "unknown"
          | "two_n";
          page_cursor?: string
          | null;
          search?: string;
          space_id?: string;
          unstable_location_id?: string | null;
          user_identifier_key?: string;
      },
      options?: DevicesListOptions,
  ): DevicesListRequest

  Parameters

  • Optionalparameters: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        custom_metadata_has?: { [x: string]: string | boolean };
        customer_key?: string;
        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"
            | "tedee_lock"
            | "akiles_lock"
            | "ultraloq_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";
        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"
            | "tedee_lock"
            | "akiles_lock"
            | "ultraloq_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"
        )[];
        exclude_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection"
            | "can_unlock_with_code"
            | "can_run_thermostat_programs"
            | "can_program_thermostat_programs_as_weekday_weekend"
            | "can_program_thermostat_programs_as_different_each_day"
            | "can_program_thermostat_programs_as_same_each_day"
            | "can_simulate_hub_connection"
            | "can_simulate_hub_disconnection"
            | "can_simulate_paid_subscription"
        )[];
        include_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection"
            | "can_unlock_with_code"
            | "can_run_thermostat_programs"
            | "can_program_thermostat_programs_as_weekday_weekend"
            | "can_program_thermostat_programs_as_different_each_day"
            | "can_program_thermostat_programs_as_same_each_day"
            | "can_simulate_hub_connection"
            | "can_simulate_hub_disconnection"
            | "can_simulate_paid_subscription"
        )[];
        limit?: number;
        manufacturer?: | "akuvox"
        | "august"
        | "avigilon_alta"
        | "brivo"
        | "butterflymx"
        | "schlage"
        | "smartthings"
        | "yale"
        | "genie"
        | "doorking"
        | "salto"
        | "lockly"
        | "ttlock"
        | "linear"
        | "noiseaware"
        | "nuki"
        | "igloo"
        | "kwikset"
        | "minut"
        | "controlbyweb"
        | "nest"
        | "igloohome"
        | "ecobee"
        | "hubitat"
        | "four_suites"
        | "dormakaba_oracode"
        | "wyze"
        | "tedee"
        | "honeywell_resideo"
        | "akiles"
        | "tado"
        | "sensi"
        | "kwikset2"
        | "keynest"
        | "ultraloq"
        | "keywe"
        | "philia"
        | "samsung"
        | "seam"
        | "unknown"
        | "two_n";
        page_cursor?: string
        | null;
        search?: string;
        space_id?: string;
        unstable_location_id?: string | null;
        user_identifier_key?: string;
    }

    • Optionalconnect_webview_id?: string

      ID of the Connect Webview for which you want to list devices.

    • Optionalconnected_account_id?: string

      ID of the connected account for which you want to list devices.

    • Optionalconnected_account_ids?: string[]

      Array of IDs of the connected accounts for which you want to list devices.

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned devices. Returns devices created before this timestamp.

    • Optionalcustom_metadata_has?: { [x: string]: string | boolean }

      Set of key:value custom metadata pairs for which you want to list devices.

    • Optionalcustomer_key?: string

      Customer key for which you want to list devices.

    • Optionaldevice_ids?: string[]

      Array of device IDs for which you want to list devices.

    • Optionaldevice_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"
          | "tedee_lock"
          | "akiles_lock"
          | "ultraloq_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"

      Device type for which you want to list devices.

    • Optionaldevice_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"
          | "tedee_lock"
          | "akiles_lock"
          | "ultraloq_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"
      )[]

      Array of device types for which you want to list devices.

    • Optionalexclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription"
      )[]

    • Optionalinclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription"
      )[]

    • Optionallimit?: number

      Numerical limit on the number of devices to return.

    • Optionalmanufacturer?:
          | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "schlage"
          | "smartthings"
          | "yale"
          | "genie"
          | "doorking"
          | "salto"
          | "lockly"
          | "ttlock"
          | "linear"
          | "noiseaware"
          | "nuki"
          | "igloo"
          | "kwikset"
          | "minut"
          | "controlbyweb"
          | "nest"
          | "igloohome"
          | "ecobee"
          | "hubitat"
          | "four_suites"
          | "dormakaba_oracode"
          | "wyze"
          | "tedee"
          | "honeywell_resideo"
          | "akiles"
          | "tado"
          | "sensi"
          | "kwikset2"
          | "keynest"
          | "ultraloq"
          | "keywe"
          | "philia"
          | "samsung"
          | "seam"
          | "unknown"
          | "two_n"

      Manufacturer for which you want to list devices.

    • Optionalpage_cursor?: string | null

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalsearch?: string

      String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id, display_name, custom_metadata or location.location_name.

    • Optionalspace_id?: string

      ID of the space for which you want to list devices.

    • Optionalunstable_location_id?: string | null

      Deprecated

      Use space_id.

    • Optionaluser_identifier_key?: string

      Your own internal user ID for the user for which you want to list devices.

  • options: DevicesListOptions = {}

  Returns DevicesListRequest

listDeviceProviders

• listDeviceProviders(
      parameters?: {
          provider_category?:
              | "noise_sensors"
              | "thermostats"
              | "stable"
              | "consumer_smartlocks"
              | "access_control_systems";
      },
      options?: DevicesListDeviceProvidersOptions,
  ): DevicesListDeviceProvidersRequest

  Parameters

  • Optionalparameters: {
        provider_category?:
            | "noise_sensors"
            | "thermostats"
            | "stable"
            | "consumer_smartlocks"
            | "access_control_systems";
    }

    • Optionalprovider_category?:
          | "noise_sensors"
          | "thermostats"
          | "stable"
          | "consumer_smartlocks"
          | "access_control_systems"

      Category for which you want to list providers.

  • options: DevicesListDeviceProvidersOptions = {}

  Returns DevicesListDeviceProvidersRequest

reportProviderMetadata

• reportProviderMetadata(
      parameters?: {
          devices: {
              device_id: string;
              ultraloq_metadata?: {
                  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";
              };
          }[];
      },
      options?: DevicesReportProviderMetadataOptions,
  ): DevicesReportProviderMetadataRequest

  Parameters

  • Optionalparameters: {
        devices: {
            device_id: string;
            ultraloq_metadata?: {
                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";
            };
        }[];
    }

    • devices: {
          device_id: string;
          ultraloq_metadata?: {
              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";
          };
      }[]

      Array of devices with provider metadata to update

  • options: DevicesReportProviderMetadataOptions = {}

  Returns DevicesReportProviderMetadataRequest

update

• update(
      parameters?: {
          custom_metadata?: { [x: string]: string | boolean | null };
          device_id: string;
          is_managed?: boolean;
          name?: string | null;
          properties?: { name?: string | null };
      },
      options?: DevicesUpdateOptions,
  ): DevicesUpdateRequest

  Parameters

  • Optionalparameters: {
        custom_metadata?: { [x: string]: string | boolean | null };
        device_id: string;
        is_managed?: boolean;
        name?: string | null;
        properties?: { name?: string | null };
    }

    • Optionalcustom_metadata?: { [x: string]: string | boolean | null }

      Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. 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.

    • device_id: string

      ID of the device that you want to update.

    • Optionalis_managed?: boolean

      Indicates whether the device is managed. To unmanage a device, set is_managed to false.

    • Optionalname?: string | null

      Name for the device.

    • Optionalproperties?: { name?: string | null }

      • Optionalname?: string | null

        Name for the device.

  • options: DevicesUpdateOptions = {}

  Returns DevicesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpDevices

  Parameters

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

  Returns SeamHttpDevices

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpDevices

  Parameters

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

  Returns SeamHttpDevices

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpDevices

  Parameters

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

  Returns SeamHttpDevices

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpDevices

  Parameters

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

  Returns SeamHttpDevices

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpDevices

  Parameters

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

  Returns SeamHttpDevices

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpDevices>

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpDevices>