Class SeamHttpAcsAccessGroups

constructor

• new SeamHttpAcsAccessGroups(apiKeyOrOptions?): SeamHttpAcsAccessGroups

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsAccessGroups

client

addUser

• addUser(body): Promise<void>

• Parameters

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

    • acs_access_group_id: string

    • acs_user_id: string

  Returns Promise<void>

create

• create(body): Promise<{
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }>

• Parameters

  • body: {
        acs_system_id: string;
        name?: string;
    }

    • acs_system_id: string

    • Optional name?: string

  Returns Promise<{
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }>

delete

• delete(body): Promise<void>

• Parameters

  • body: {
        acs_access_group_id: string;
    }

    • acs_access_group_id: string

  Returns Promise<void>

get

• get(body): Promise<{
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }>

• Parameters

  • body: {
        acs_access_group_id: string;
    }

    • acs_access_group_id: string

  Returns Promise<{
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }>

list

• list(body): Promise<{
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }[]>

• Parameters

  • body: {
        acs_system_id?: string;
        acs_user_id?: string;
    }

    • Optional acs_system_id?: string

    • Optional acs_user_id?: string

  Returns Promise<{
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }[]>

listUsers

• listUsers(body): Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      external_type: "pti_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }[]>

• Parameters

  • body: {
        acs_access_group_id: string;
    }

    • acs_access_group_id: string

  Returns Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      external_type: "pti_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }[]>

removeUser

• removeUser(body): Promise<void>

• Parameters

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

    • acs_access_group_id: string

    • acs_user_id: string

  Returns Promise<void>

update

• update(body): Promise<void>

• Parameters

  • body: {
        acs_access_group_id: string;
        name?: null | string;
    }

    • acs_access_group_id: string

    • Optional name?: null | string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsAccessGroups

• Parameters

  • apiKey: string

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

  Returns SeamHttpAcsAccessGroups

Static fromClient

• fromClient(client, options?): SeamHttpAcsAccessGroups

• Parameters

  • client: AxiosInstance

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

  Returns SeamHttpAcsAccessGroups

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsAccessGroups

• Parameters

  • clientSessionToken: string

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

  Returns SeamHttpAcsAccessGroups

Static fromPublishableKey

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

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsAccessGroups>