Documentation

Mistake on this page? Email us

ApiKey repository

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initalise a new instance of the repository

    Parameters

    • Optional config: ConfigOptions

      The configuration to use, if null then repository will initalise its own using dotenv

    • Optional client: Client

      The client instance to use

    Returns ApiKeyRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

  • create

    Parameters

    Returns Promise<ApiKey>

delete

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

    Parameters

    • id: string

      The ID of the API key to delete.

    Returns Promise<void>

list

  • list(options?: ApiKeyListOptions): Paginator<ApiKey, ListOptions>
  • list

    Parameters

    • Optional options: ApiKeyListOptions

      Options to use for the List

    Returns Paginator<ApiKey, ListOptions>

me

  • me(): Promise<ApiKey>
  • me

    Returns Promise<ApiKey>

policyGroups

  • policyGroups

    Parameters

    • id: string

      The ID of the API key.

    • Optional options: ListOptions

      options

    Returns Paginator<PolicyGroup, ListOptions>

read

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

    Parameters

    • id: string

      The ID of the API key.

    Returns Promise<ApiKey>

update

  • update

    Parameters

    • request: ApiKeyUpdateRequest

      The entity to perform action on.

    • id: string

      The ID of the API key.

    Returns Promise<ApiKey>