Documentation

Mistake on this page? Email us

PreSharedKey repository

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initalise a new instance of the repository

    Parameters

    • Optional config: Config

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

    • Optional client: Client

      The client instance to use

    Returns PreSharedKeyRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

delete

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

    Parameters

    • id: string

      The Id of the pre_shared_key, shadows the endpoint_name

    Returns Promise<void>

list

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

    Parameters

    • Optional options: ListOptions

      options

    Returns Paginator<PreSharedKey, ListOptions>

read

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

    Parameters

    • id: string

      The Id of the pre_shared_key, shadows the endpoint_name

    Returns Promise<PreSharedKey>