Class SeamHttpUserIdentities

constructor

• new SeamHttpUserIdentities(apiKeyOrOptions?): SeamHttpUserIdentities

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentities

client

Readonly defaults

enrollmentAutomations

• get enrollmentAutomations(): SeamHttpUserIdentitiesEnrollmentAutomations

• Returns SeamHttpUserIdentitiesEnrollmentAutomations

addAcsUser

• addAcsUser(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        acs_user_id: string;
        user_identity_id: string;
    }

    • acs_user_id: string

    • user_identity_id: string

  Returns SeamHttpRequest<void, undefined>

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      user_identity: {
          created_at: string;
          display_name: string;
          email_address: null | string;
          full_name: null | string;
          phone_number: null | string;
          user_identity_id: string;
          user_identity_key: null | string;
          workspace_id: string;
      };
  }>, "user_identity">, "user_identity">

• Parameters

  • Optional body: {
        email_address?: null | string;
        full_name?: null | string;
        phone_number?: null | string;
        user_identity_key?: null | string;
    }

    • Optional email_address?: null | string

    • Optional full_name?: null | string

    • Optional phone_number?: null | string

    • Optional user_identity_key?: null | string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      user_identity: {
          created_at: string;
          display_name: string;
          email_address: null | string;
          full_name: null | string;
          phone_number: null | string;
          user_identity_id: string;
          user_identity_key: null | string;
          workspace_id: string;
      };
  }>, "user_identity">, "user_identity">

delete

• delete(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      user_identity: {
          created_at: string;
          display_name: string;
          email_address: null | string;
          full_name: null | string;
          phone_number: null | string;
          user_identity_id: string;
          user_identity_key: null | string;
          workspace_id: string;
      };
  }>, "user_identity">, "user_identity">

• Parameters

  • Optional body: UserIdentitiesGetParams

  Returns SeamHttpRequest<SetNonNullable<Required<{
      user_identity: {
          created_at: string;
          display_name: string;
          email_address: null | string;
          full_name: null | string;
          phone_number: null | string;
          user_identity_id: string;
          user_identity_key: null | string;
          workspace_id: string;
      };
  }>, "user_identity">, "user_identity">

grantAccessToDevice

• grantAccessToDevice(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        device_id: string;
        user_identity_id: string;
    }

    • device_id: string

    • user_identity_id: string

  Returns SeamHttpRequest<void, undefined>

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      user_identities: {
          created_at: string;
          display_name: string;
          email_address: null | string;
          full_name: null | string;
          phone_number: null | string;
          user_identity_id: string;
          user_identity_key: null | string;
          workspace_id: string;
      }[];
  }>, "user_identities">, "user_identities">

• Parameters

  • Optional body: {
        credential_manager_acs_system_id?: string;
    }

    • Optional credential_manager_acs_system_id?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      user_identities: {
          created_at: string;
          display_name: string;
          email_address: null | string;
          full_name: null | string;
          phone_number: null | string;
          user_identity_id: string;
          user_identity_key: null | string;
          workspace_id: string;
      }[];
  }>, "user_identities">, "user_identities">

listAccessibleDevices

• listAccessibleDevices(body?): SeamHttpRequest<SetNonNullable<Required<{
      accessible_devices: {
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_removal?: boolean;
          capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone";
          display_name: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: (...) | (...);
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status: (...) | (...) | (...) | (...);
              };
              battery_level?: number;
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
              serial_number?: string;
              supports_accessory_keypad?: boolean;
              supports_offline_access_codes?: boolean;
          } & {
              assa_abloy_credential_service_metadata?: {
                  endpoints: (...)[];
                  has_active_endpoint: boolean;
              };
          } & {
              august_metadata?: {
                  has_keypad: boolean;
                  house_id?: (...) | (...);
                  house_name: string;
                  keypad_battery_level?: (...) | (...);
                  lock_id: string;
                  lock_name: string;
                  model?: (...) | (...);
              };
              avigilon_alta_metadata?: {
                  entry_name: string;
                  org_name: string;
                  site_id: number;
                  site_name: string;
                  zone_id: number;
                  zone_name: string;
              };
              brivo_metadata?: {
                  device_name: string;
              };
              controlbyweb_metadata?: {
                  device_id: string;
                  device_name: string;
                  relay_name: (...) | (...);
              };
              dormakaba_oracode_metadata?: {
                  device_id?: (...) | (...);
                  door_id: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: (...) | (...);
                  predefined_time_slots?: (...) | (...);
                  site_id: number;
                  site_name: string;
              };
              ecobee_metadata?: {
                  device_name: string;
                  ecobee_device_id: string;
              };
              four_suites_metadata?: {
                  device_id: number;
                  device_name: string;
                  reclose_delay_in_seconds: number;
              };
              genie_metadata?: {
                  device_name: string;
                  door_name: string;
              };
              honeywell_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_device_id: string;
              };
              hubitat_metadata?: {
                  device_id: string;
                  device_label: string;
                  device_name: string;
              };
              igloo_metadata?: {
                  bridge_id: string;
                  device_id: string;
                  model?: (...) | (...);
              };
              igloohome_metadata?: {
                  bridge_id?: (...) | (...);
                  bridge_name?: (...) | (...);
                  device_id: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
              };
              kwikset_metadata?: {
                  device_id: string;
                  device_name: string;
                  model_number: string;
              };
              lockly_metadata?: {
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              minut_metadata?: {
                  device_id: string;
                  device_name: string;
                  latest_sensor_values: {
                      accelerometer_z: ...;
                      humidity: ...;
                      pressure: ...;
                      sound: ...;
                      temperature: ...;
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  nest_device_id: string;
              };
              noiseaware_metadata?: {
                  device_id: string;
                  device_model: (...) | (...);
                  device_name: string;
                  noise_level_decibel: number;
                  noise_level_nrs: number;
              };
              nuki_metadata?: {
                  device_id: string;
                  device_name: string;
                  keypad_2_paired?: (...) | (...) | (...);
                  keypad_battery_critical?: (...) | (...) | (...);
                  keypad_paired?: (...) | (...) | (...);
              };
              salto_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: (...) | (...);
              };
              schlage_metadata?: {
                  access_code_length: (...) | (...);
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              seam_bridge_metadata?: {
                  device_num: number;
                  name: string;
                  unlock_method?: (...) | (...) | (...);
              };
              smartthings_metadata?: {
                  device_id: string;
                  device_name: string;
                  location_id?: (...) | (...);
                  model?: (...) | (...);
              };
              tedee_metadata?: {
                  bridge_id: number;
                  bridge_name: string;
                  device_id: number;
                  device_model: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
                  serial_number: string;
              };
              ttlock_metadata?: {
                  lock_alias: string;
                  lock_id: number;
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: (...) | (...);
                  locker_status_hardlock?: (...) | (...);
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
      devices: {
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_removal?: boolean;
          capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone";
          display_name: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: (...) | (...);
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status: (...) | (...) | (...) | (...);
              };
              battery_level?: number;
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
              serial_number?: string;
              supports_accessory_keypad?: boolean;
              supports_offline_access_codes?: boolean;
          } & {
              assa_abloy_credential_service_metadata?: {
                  endpoints: (...)[];
                  has_active_endpoint: boolean;
              };
          } & {
              august_metadata?: {
                  has_keypad: boolean;
                  house_id?: (...) | (...);
                  house_name: string;
                  keypad_battery_level?: (...) | (...);
                  lock_id: string;
                  lock_name: string;
                  model?: (...) | (...);
              };
              avigilon_alta_metadata?: {
                  entry_name: string;
                  org_name: string;
                  site_id: number;
                  site_name: string;
                  zone_id: number;
                  zone_name: string;
              };
              brivo_metadata?: {
                  device_name: string;
              };
              controlbyweb_metadata?: {
                  device_id: string;
                  device_name: string;
                  relay_name: (...) | (...);
              };
              dormakaba_oracode_metadata?: {
                  device_id?: (...) | (...);
                  door_id: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: (...) | (...);
                  predefined_time_slots?: (...) | (...);
                  site_id: number;
                  site_name: string;
              };
              ecobee_metadata?: {
                  device_name: string;
                  ecobee_device_id: string;
              };
              four_suites_metadata?: {
                  device_id: number;
                  device_name: string;
                  reclose_delay_in_seconds: number;
              };
              genie_metadata?: {
                  device_name: string;
                  door_name: string;
              };
              honeywell_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_device_id: string;
              };
              hubitat_metadata?: {
                  device_id: string;
                  device_label: string;
                  device_name: string;
              };
              igloo_metadata?: {
                  bridge_id: string;
                  device_id: string;
                  model?: (...) | (...);
              };
              igloohome_metadata?: {
                  bridge_id?: (...) | (...);
                  bridge_name?: (...) | (...);
                  device_id: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
              };
              kwikset_metadata?: {
                  device_id: string;
                  device_name: string;
                  model_number: string;
              };
              lockly_metadata?: {
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              minut_metadata?: {
                  device_id: string;
                  device_name: string;
                  latest_sensor_values: {
                      accelerometer_z: ...;
                      humidity: ...;
                      pressure: ...;
                      sound: ...;
                      temperature: ...;
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  nest_device_id: string;
              };
              noiseaware_metadata?: {
                  device_id: string;
                  device_model: (...) | (...);
                  device_name: string;
                  noise_level_decibel: number;
                  noise_level_nrs: number;
              };
              nuki_metadata?: {
                  device_id: string;
                  device_name: string;
                  keypad_2_paired?: (...) | (...) | (...);
                  keypad_battery_critical?: (...) | (...) | (...);
                  keypad_paired?: (...) | (...) | (...);
              };
              salto_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: (...) | (...);
              };
              schlage_metadata?: {
                  access_code_length: (...) | (...);
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              seam_bridge_metadata?: {
                  device_num: number;
                  name: string;
                  unlock_method?: (...) | (...) | (...);
              };
              smartthings_metadata?: {
                  device_id: string;
                  device_name: string;
                  location_id?: (...) | (...);
                  model?: (...) | (...);
              };
              tedee_metadata?: {
                  bridge_id: number;
                  bridge_name: string;
                  device_id: number;
                  device_model: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
                  serial_number: string;
              };
              ttlock_metadata?: {
                  lock_alias: string;
                  lock_id: number;
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: (...) | (...);
                  locker_status_hardlock?: (...) | (...);
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "devices" | "accessible_devices">, "devices">

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      accessible_devices: {
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_removal?: boolean;
          capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone";
          display_name: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: (...) | (...);
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status: (...) | (...) | (...) | (...);
              };
              battery_level?: number;
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
              serial_number?: string;
              supports_accessory_keypad?: boolean;
              supports_offline_access_codes?: boolean;
          } & {
              assa_abloy_credential_service_metadata?: {
                  endpoints: (...)[];
                  has_active_endpoint: boolean;
              };
          } & {
              august_metadata?: {
                  has_keypad: boolean;
                  house_id?: (...) | (...);
                  house_name: string;
                  keypad_battery_level?: (...) | (...);
                  lock_id: string;
                  lock_name: string;
                  model?: (...) | (...);
              };
              avigilon_alta_metadata?: {
                  entry_name: string;
                  org_name: string;
                  site_id: number;
                  site_name: string;
                  zone_id: number;
                  zone_name: string;
              };
              brivo_metadata?: {
                  device_name: string;
              };
              controlbyweb_metadata?: {
                  device_id: string;
                  device_name: string;
                  relay_name: (...) | (...);
              };
              dormakaba_oracode_metadata?: {
                  device_id?: (...) | (...);
                  door_id: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: (...) | (...);
                  predefined_time_slots?: (...) | (...);
                  site_id: number;
                  site_name: string;
              };
              ecobee_metadata?: {
                  device_name: string;
                  ecobee_device_id: string;
              };
              four_suites_metadata?: {
                  device_id: number;
                  device_name: string;
                  reclose_delay_in_seconds: number;
              };
              genie_metadata?: {
                  device_name: string;
                  door_name: string;
              };
              honeywell_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_device_id: string;
              };
              hubitat_metadata?: {
                  device_id: string;
                  device_label: string;
                  device_name: string;
              };
              igloo_metadata?: {
                  bridge_id: string;
                  device_id: string;
                  model?: (...) | (...);
              };
              igloohome_metadata?: {
                  bridge_id?: (...) | (...);
                  bridge_name?: (...) | (...);
                  device_id: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
              };
              kwikset_metadata?: {
                  device_id: string;
                  device_name: string;
                  model_number: string;
              };
              lockly_metadata?: {
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              minut_metadata?: {
                  device_id: string;
                  device_name: string;
                  latest_sensor_values: {
                      accelerometer_z: ...;
                      humidity: ...;
                      pressure: ...;
                      sound: ...;
                      temperature: ...;
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  nest_device_id: string;
              };
              noiseaware_metadata?: {
                  device_id: string;
                  device_model: (...) | (...);
                  device_name: string;
                  noise_level_decibel: number;
                  noise_level_nrs: number;
              };
              nuki_metadata?: {
                  device_id: string;
                  device_name: string;
                  keypad_2_paired?: (...) | (...) | (...);
                  keypad_battery_critical?: (...) | (...) | (...);
                  keypad_paired?: (...) | (...) | (...);
              };
              salto_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: (...) | (...);
              };
              schlage_metadata?: {
                  access_code_length: (...) | (...);
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              seam_bridge_metadata?: {
                  device_num: number;
                  name: string;
                  unlock_method?: (...) | (...) | (...);
              };
              smartthings_metadata?: {
                  device_id: string;
                  device_name: string;
                  location_id?: (...) | (...);
                  model?: (...) | (...);
              };
              tedee_metadata?: {
                  bridge_id: number;
                  bridge_name: string;
                  device_id: number;
                  device_model: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
                  serial_number: string;
              };
              ttlock_metadata?: {
                  lock_alias: string;
                  lock_id: number;
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: (...) | (...);
                  locker_status_hardlock?: (...) | (...);
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
      devices: {
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_removal?: boolean;
          capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone";
          display_name: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: (...) | (...);
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status: (...) | (...) | (...) | (...);
              };
              battery_level?: number;
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
              serial_number?: string;
              supports_accessory_keypad?: boolean;
              supports_offline_access_codes?: boolean;
          } & {
              assa_abloy_credential_service_metadata?: {
                  endpoints: (...)[];
                  has_active_endpoint: boolean;
              };
          } & {
              august_metadata?: {
                  has_keypad: boolean;
                  house_id?: (...) | (...);
                  house_name: string;
                  keypad_battery_level?: (...) | (...);
                  lock_id: string;
                  lock_name: string;
                  model?: (...) | (...);
              };
              avigilon_alta_metadata?: {
                  entry_name: string;
                  org_name: string;
                  site_id: number;
                  site_name: string;
                  zone_id: number;
                  zone_name: string;
              };
              brivo_metadata?: {
                  device_name: string;
              };
              controlbyweb_metadata?: {
                  device_id: string;
                  device_name: string;
                  relay_name: (...) | (...);
              };
              dormakaba_oracode_metadata?: {
                  device_id?: (...) | (...);
                  door_id: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: (...) | (...);
                  predefined_time_slots?: (...) | (...);
                  site_id: number;
                  site_name: string;
              };
              ecobee_metadata?: {
                  device_name: string;
                  ecobee_device_id: string;
              };
              four_suites_metadata?: {
                  device_id: number;
                  device_name: string;
                  reclose_delay_in_seconds: number;
              };
              genie_metadata?: {
                  device_name: string;
                  door_name: string;
              };
              honeywell_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_device_id: string;
              };
              hubitat_metadata?: {
                  device_id: string;
                  device_label: string;
                  device_name: string;
              };
              igloo_metadata?: {
                  bridge_id: string;
                  device_id: string;
                  model?: (...) | (...);
              };
              igloohome_metadata?: {
                  bridge_id?: (...) | (...);
                  bridge_name?: (...) | (...);
                  device_id: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
              };
              kwikset_metadata?: {
                  device_id: string;
                  device_name: string;
                  model_number: string;
              };
              lockly_metadata?: {
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              minut_metadata?: {
                  device_id: string;
                  device_name: string;
                  latest_sensor_values: {
                      accelerometer_z: ...;
                      humidity: ...;
                      pressure: ...;
                      sound: ...;
                      temperature: ...;
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  nest_device_id: string;
              };
              noiseaware_metadata?: {
                  device_id: string;
                  device_model: (...) | (...);
                  device_name: string;
                  noise_level_decibel: number;
                  noise_level_nrs: number;
              };
              nuki_metadata?: {
                  device_id: string;
                  device_name: string;
                  keypad_2_paired?: (...) | (...) | (...);
                  keypad_battery_critical?: (...) | (...) | (...);
                  keypad_paired?: (...) | (...) | (...);
              };
              salto_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: (...) | (...);
              };
              schlage_metadata?: {
                  access_code_length: (...) | (...);
                  device_id: string;
                  device_name: string;
                  model?: (...) | (...);
              };
              seam_bridge_metadata?: {
                  device_num: number;
                  name: string;
                  unlock_method?: (...) | (...) | (...);
              };
              smartthings_metadata?: {
                  device_id: string;
                  device_name: string;
                  location_id?: (...) | (...);
                  model?: (...) | (...);
              };
              tedee_metadata?: {
                  bridge_id: number;
                  bridge_name: string;
                  device_id: number;
                  device_model: string;
                  device_name: string;
                  keypad_id?: (...) | (...);
                  serial_number: string;
              };
              ttlock_metadata?: {
                  lock_alias: string;
                  lock_id: number;
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: (...) | (...);
                  locker_status_hardlock?: (...) | (...);
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "devices" | "accessible_devices">, "devices">

listAcsSystems

• listAcsSystems(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_systems: {
          acs_system_id: string;
          can_automate_enrollment?: boolean;
          connected_account_ids: string[];
          created_at: string;
          external_type?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          name: string;
          system_type?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building";
          system_type_display_name?: string;
          workspace_id: string;
      }[];
  }>, "acs_systems">, "acs_systems">

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_systems: {
          acs_system_id: string;
          can_automate_enrollment?: boolean;
          connected_account_ids: string[];
          created_at: string;
          external_type?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          name: string;
          system_type?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building";
          system_type_display_name?: string;
          workspace_id: string;
      }[];
  }>, "acs_systems">, "acs_systems">

listAcsUsers

• listAcsUsers(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_users: {
          access_schedule?: {
              ends_at: string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          created_at: string;
          display_name: string;
          email?: string;
          email_address?: string;
          external_type?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_suspended: boolean;
          phone_number?: string;
          user_identity_email_address?: null | string;
          user_identity_full_name?: null | string;
          user_identity_id?: string;
          user_identity_phone_number?: null | string;
          workspace_id: string;
      }[];
  }>, "acs_users">, "acs_users">

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_users: {
          access_schedule?: {
              ends_at: string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          created_at: string;
          display_name: string;
          email?: string;
          email_address?: string;
          external_type?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_suspended: boolean;
          phone_number?: string;
          user_identity_email_address?: null | string;
          user_identity_full_name?: null | string;
          user_identity_id?: string;
          user_identity_phone_number?: null | string;
          workspace_id: string;
      }[];
  }>, "acs_users">, "acs_users">

removeAcsUser

• removeAcsUser(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        acs_user_id: string;
        user_identity_id: string;
    }

    • acs_user_id: string

    • user_identity_id: string

  Returns SeamHttpRequest<void, undefined>

revokeAccessToDevice

• revokeAccessToDevice(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        device_id: string;
        user_identity_id: string;
    }

    • device_id: string

    • user_identity_id: string

  Returns SeamHttpRequest<void, undefined>

update

• update(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        email_address?: null | string;
        full_name?: null | string;
        phone_number?: null | string;
        user_identity_id: string;
        user_identity_key?: null | string;
    }

    • Optional email_address?: null | string

    • Optional full_name?: null | string

    • Optional phone_number?: null | string

    • user_identity_id: string

    • Optional user_identity_key?: null | string

  Returns SeamHttpRequest<void, undefined>