Class SeamHttpAcsUsers

constructor

• new SeamHttpAcsUsers(apiKeyOrOptions?): SeamHttpAcsUsers

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsers

client

Readonly defaults

addToAccessGroup

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

• Parameters

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

    • acs_access_group_id: string

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_user: {
          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_user">, "acs_user">

• Parameters

  • Optional body: {
        access_schedule?: {
            ends_at: string;
            starts_at: string;
        };
        acs_access_group_ids?: string[];
        acs_system_id: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        phone_number?: string;
        user_identity_id?: string;
    }

    • Optional access_schedule?: {
          ends_at: string;
          starts_at: string;
      }

      • ends_at: string

      • starts_at: string

    • Optional acs_access_group_ids?: string[]

    • acs_system_id: string

    • Optional email?: string

      ---

      deprecated: use email_address.

    • Optional email_address?: string

    • Optional full_name?: string

    • Optional phone_number?: string

    • Optional user_identity_id?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_user: {
          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_user">, "acs_user">

delete

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

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_user: {
          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_user">, "acs_user">

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_user: {
          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_user">, "acs_user">

list

• list(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: {
        acs_system_id?: string;
        user_identity_email_address?: string;
        user_identity_id?: string;
        user_identity_phone_number?: string;
    }

    • Optional acs_system_id?: string

    • Optional user_identity_email_address?: string

    • Optional user_identity_id?: string

    • Optional user_identity_phone_number?: 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">

listAccessibleEntrances

• listAccessibleEntrances(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          created_at: string;
          display_name: string;
          latch_metadata: null | {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          visionline_metadata: null | {
              door_category: "common" | "entrance" | "guest" | "elevator reader" | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          created_at: string;
          display_name: string;
          latch_metadata: null | {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          visionline_metadata: null | {
              door_category: "common" | "entrance" | "guest" | "elevator reader" | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

removeFromAccessGroup

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

• Parameters

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

    • acs_access_group_id: string

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

revokeAccessToAllEntrances

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

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

suspend

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

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

unsuspend

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

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

update

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

• Parameters

  • Optional body: {
        access_schedule?: {
            ends_at: string;
            starts_at: string;
        };
        acs_user_id: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        phone_number?: string;
    }

    • Optional access_schedule?: {
          ends_at: string;
          starts_at: string;
      }

      • ends_at: string

      • starts_at: string

    • acs_user_id: string

    • Optional email?: string

      ---

      deprecated: use email_address.

    • Optional email_address?: string

    • Optional full_name?: string

    • Optional hid_acs_system_id?: string

    • Optional phone_number?: string

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsUsers

• Parameters

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

  Returns SeamHttpAcsUsers

Static fromClient

• fromClient(client, options?): SeamHttpAcsUsers

• Parameters

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

  Returns SeamHttpAcsUsers

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsUsers

• Parameters

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

  Returns SeamHttpAcsUsers

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAcsUsers

• Parameters

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

  Returns SeamHttpAcsUsers

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAcsUsers

• Parameters

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

  Returns SeamHttpAcsUsers

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAcsUsers>

• Parameters

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

  Returns Promise<SeamHttpAcsUsers>