Documentation

Mistake on this page? Email us

User repository

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

  • create

    Parameters

    • request: UserCreateRequest

      The entity to perform action on.

    • Optional action: string

      Action, either create or invite.

    Returns Promise<User>

delete

  • delete(id: string): Promise<void>
  • delete

    Parameters

    • id: string

      The ID of the user to delete.

    Returns Promise<void>

list

  • list

    Parameters

    • Optional options: UserListOptions

      Options to use for the List

    Returns Paginator<User, ListOptions>

read

  • read(id: string): Promise<User>
  • read

    Parameters

    • id: string

      The ID of the user.

    Returns Promise<User>

update

  • update

    Parameters

    • request: UserUpdateRequest

      The entity to perform action on.

    • id: string

      The ID of the user.

    Returns Promise<User>