Class SeamHttpAcsAccessGroups

Constructors

Properties

client: AxiosInstance
defaults: Required<SeamHttpRequestOptions>

Accessors

Methods

  • Parameters

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

        ID of the desired access group.

      • acs_user_id: string

        ID of the desired user.

    Returns SeamHttpRequest<void, undefined>

  • Parameters

    • Optionalbody: {
          acs_access_group_id: string;
      }
      • acs_access_group_id: string

        ID of the desired access group.

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

  • Parameters

    • Optionalbody: {
          acs_system_id?: string;
          acs_user_id?: string;
      }
      • Optionalacs_system_id?: string

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

      • Optionalacs_user_id?: string

        ID of the user 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";
            access_group_type_display_name: string;
            acs_access_group_id: string;
            acs_system_id: string;
            created_at: string;
            display_name: string;
            external_type:
                | "pti_unit"
                | "pti_access_level"
                | "salto_ks_access_group"
                | "brivo_group"
                | "salto_space_group";
            external_type_display_name: string;
            is_managed: true;
            name: string;
            workspace_id: string;
        }[];
    }>, "acs_access_groups">, "acs_access_groups">

  • Parameters

    • Optionalbody: {
          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;
                common_area_number?: number;
                inner_access_points_names?: string[];
                lease_ids?: 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

    • Optionalbody: {
          acs_access_group_id: string;
      }
      • acs_access_group_id: string

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

    Returns SeamHttpRequest<SetNonNullable<Required<{
        acs_users: {
            access_schedule?: {
                ends_at: null | string;
                starts_at: string;
            };
            acs_system_id: string;
            acs_user_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;
                })[];
            external_type?:
                | "pti_user"
                | "brivo_user"
                | "hid_credential_manager_user"
                | "salto_site_user"
                | "latch_user"
                | "dormakaba_community_user";
            external_type_display_name?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            is_latest_desired_state_synced_with_provider?: boolean;
            is_managed: true;
            is_suspended?: boolean;
            latest_desired_state_synced_with_provider_at?: string;
            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";
            })[];
            workspace_id: string;
        }[];
    }>, "acs_users">, "acs_users">

  • Parameters

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

        ID of the desired access group.

      • acs_user_id: string

        ID of the desired user.

    Returns SeamHttpRequest<void, undefined>

  • Parameters

    • clientSessionToken: string

    Returns Promise<void>