Class SeamHttpAcsAccessGroups

constructor

• new SeamHttpAcsAccessGroups(apiKeyOrOptions?): SeamHttpAcsAccessGroups

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsAccessGroups

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

addUser

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

• Parameters

  • Optionalbody: {
        acs_access_group_id: string;
        acs_user_id?: string;
        user_identity_id?: string;
    }

    • acs_access_group_id: string

      ID of the access group to which you want to add an access system user.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same email_address or phone_number as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.

  Returns SeamHttpRequest<void, undefined>

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_access_group: {
          access_group_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          access_group_type_display_name: string;
          acs_access_group_id: string;
          acs_system_id: string;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          external_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          external_type_display_name: string;
          is_managed: true;
          name: string;
          warnings: {
              created_at: string;
              message: string;
              warning_code: "unknown_issue_with_acs_access_group";
          }[];
          workspace_id: string;
      };
  }>, "acs_access_group">, "acs_access_group">

• Parameters

  • Optionalparams: {
        acs_access_group_id: string;
    }

    • acs_access_group_id: string

      ID of the access group that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_access_group: {
          access_group_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          access_group_type_display_name: string;
          acs_access_group_id: string;
          acs_system_id: string;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          external_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          external_type_display_name: string;
          is_managed: true;
          name: string;
          warnings: {
              created_at: string;
              message: string;
              warning_code: "unknown_issue_with_acs_access_group";
          }[];
          workspace_id: string;
      };
  }>, "acs_access_group">, "acs_access_group">

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_access_groups: {
          access_group_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          access_group_type_display_name: string;
          acs_access_group_id: string;
          acs_system_id: string;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          external_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          external_type_display_name: string;
          is_managed: true;
          name: string;
          warnings: {
              created_at: string;
              message: string;
              warning_code: "unknown_issue_with_acs_access_group";
          }[];
          workspace_id: string;
      }[];
  }>, "acs_access_groups">, "acs_access_groups">

• Parameters

  • Optionalparams: {
        acs_system_id?: string;
        acs_user_id?: string;
        user_identity_id?: string;
    }

    • Optionalacs_system_id?: string

      ID of the access system for which you want to retrieve all access groups.

    • Optionalacs_user_id?: string

      ID of the access system user for which you want to retrieve all access groups.

    • Optionaluser_identity_id?: string

      ID of the user identity for which you want to retrieve all access groups.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_access_groups: {
          access_group_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          access_group_type_display_name: string;
          acs_access_group_id: string;
          acs_system_id: string;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          external_type:
              | "pti_unit"
              | "pti_access_level"
              | "salto_ks_access_group"
              | "brivo_group"
              | "salto_space_group"
              | "dormakaba_community_access_group";
          external_type_display_name: string;
          is_managed: true;
          name: string;
          warnings: {
              created_at: string;
              message: string;
              warning_code: "unknown_issue_with_acs_access_group";
          }[];
          workspace_id: string;
      }[];
  }>, "acs_access_groups">, "acs_access_groups">

listAccessibleEntrances

• listAccessibleEntrances(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          assa_abloy_vostio_metadata?: {
              door_name: string;
              door_number?: number;
              door_type:
                  | "CommonDoor"
                  | "EntranceDoor"
                  | "GuestDoor"
                  | "Elevator";
              pms_id?: string;
              stand_open?: boolean;
          };
          created_at: string;
          display_name: string;
          dormakaba_community_metadata?: {
              access_point_name: string;
          };
          errors: {
              error_code: string;
              message: string;
          }[];
          latch_metadata?: {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          salto_ks_metadata?: {
              battery_level: string;
              door_name: string;
              intrusion_alarm?: boolean;
              left_open_alarm?: boolean;
              lock_type: string;
              locked_state: string;
              online?: boolean;
              privacy_mode?: boolean;
          };
          salto_space_metadata?: {
              door_description?: string;
              door_name: string;
              ext_door_id: string;
          };
          visionline_metadata?: {
              door_category:
                  | "common"
                  | "guest"
                  | "entrance"
                  | "elevator reader"
                  | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

• Parameters

  • Optionalparams: {
        acs_access_group_id: string;
    }

    • acs_access_group_id: string

      ID of the access group for which you want to retrieve all accessible entrances.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          assa_abloy_vostio_metadata?: {
              door_name: string;
              door_number?: number;
              door_type:
                  | "CommonDoor"
                  | "EntranceDoor"
                  | "GuestDoor"
                  | "Elevator";
              pms_id?: string;
              stand_open?: boolean;
          };
          created_at: string;
          display_name: string;
          dormakaba_community_metadata?: {
              access_point_name: string;
          };
          errors: {
              error_code: string;
              message: string;
          }[];
          latch_metadata?: {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          salto_ks_metadata?: {
              battery_level: string;
              door_name: string;
              intrusion_alarm?: boolean;
              left_open_alarm?: boolean;
              lock_type: string;
              locked_state: string;
              online?: boolean;
              privacy_mode?: boolean;
          };
          salto_space_metadata?: {
              door_description?: string;
              door_name: string;
              ext_door_id: string;
          };
          visionline_metadata?: {
              door_category:
                  | "common"
                  | "guest"
                  | "entrance"
                  | "elevator reader"
                  | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

listUsers

• listUsers(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_users: {
          access_schedule?: {
              ends_at: null | string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          email?: string;
          email_address?: string;
          errors: (
              | {
                  created_at: string;
                  error_code: "deleted_externally";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "salto_ks_subscription_limit_exceeded";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "failed_to_create_on_acs_system";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "failed_to_update_on_acs_system";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "failed_to_delete_on_acs_system";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "latch_conflict_with_resident_user";
                  message: string;
              })[];
          external_type?:
              | "pti_user"
              | "brivo_user"
              | "hid_credential_manager_user"
              | "salto_site_user"
              | "latch_user"
              | "dormakaba_community_user"
              | "salto_space_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_managed: true;
          is_suspended?: boolean;
          last_successful_sync_at: null | string;
          pending_mutations?: (
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "creating";
              }
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "deleting";
              }
              | {
                  created_at: string;
                  from: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
                  message: string;
                  mutation_code: "updating_user_information";
                  to: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      ends_at: ...;
                      starts_at: ...;
                  };
                  message: string;
                  mutation_code: "updating_access_schedule";
                  to: {
                      ends_at: ...;
                      starts_at: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      is_suspended: ...;
                  };
                  message: string;
                  mutation_code: "updating_suspension_state";
                  to: {
                      is_suspended: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      acs_access_group_id: ...;
                  };
                  message: string;
                  mutation_code: "updating_group_membership";
                  to: {
                      acs_access_group_id: ...;
                  };
              })[];
          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;
          warnings: (
              | {
                  created_at: string;
                  message: string;
                  warning_code: "being_deleted";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "salto_ks_user_not_subscribed";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_user";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "latch_resident_user";
              })[];
          workspace_id: string;
      }[];
  }>, "acs_users">, "acs_users">

• Parameters

  • Optionalparams: {
        acs_access_group_id: string;
    }

    • acs_access_group_id: string

      ID of the access group for which you want to retrieve all access system users.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_users: {
          access_schedule?: {
              ends_at: null | string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          email?: string;
          email_address?: string;
          errors: (
              | {
                  created_at: string;
                  error_code: "deleted_externally";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "salto_ks_subscription_limit_exceeded";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "failed_to_create_on_acs_system";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "failed_to_update_on_acs_system";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "failed_to_delete_on_acs_system";
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "latch_conflict_with_resident_user";
                  message: string;
              })[];
          external_type?:
              | "pti_user"
              | "brivo_user"
              | "hid_credential_manager_user"
              | "salto_site_user"
              | "latch_user"
              | "dormakaba_community_user"
              | "salto_space_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_managed: true;
          is_suspended?: boolean;
          last_successful_sync_at: null | string;
          pending_mutations?: (
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "creating";
              }
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "deleting";
              }
              | {
                  created_at: string;
                  from: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
                  message: string;
                  mutation_code: "updating_user_information";
                  to: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      ends_at: ...;
                      starts_at: ...;
                  };
                  message: string;
                  mutation_code: "updating_access_schedule";
                  to: {
                      ends_at: ...;
                      starts_at: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      is_suspended: ...;
                  };
                  message: string;
                  mutation_code: "updating_suspension_state";
                  to: {
                      is_suspended: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      acs_access_group_id: ...;
                  };
                  message: string;
                  mutation_code: "updating_group_membership";
                  to: {
                      acs_access_group_id: ...;
                  };
              })[];
          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;
          warnings: (
              | {
                  created_at: string;
                  message: string;
                  warning_code: "being_deleted";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "salto_ks_user_not_subscribed";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_user";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "latch_resident_user";
              })[];
          workspace_id: string;
      }[];
  }>, "acs_users">, "acs_users">

removeUser

• removeUser(params?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalparams: {
        acs_access_group_id: string;
        acs_user_id?: string;
        user_identity_id?: string;
    }

    • acs_access_group_id: string

      ID of the access group from which you want to remove an access system user.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to remove from an access group.

    • Optionaluser_identity_id?: string

      ID of the user identity associated with the user that you want to remove from an access group.

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsAccessGroups

• Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromClient

• fromClient(client, options?): SeamHttpAcsAccessGroups

• Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsAccessGroups

• Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAcsAccessGroups>