Class NotesAPI

See

Not3Client.notes

Hierarchy (View Summary)

SubClient
- NotesAPI

Index

Constructors

Properties

Methods

create delete get

Constructors

constructor

new NotesAPI(api: AxiosInstance, options: ClientOptions): NotesAPI
Parameters
- api: AxiosInstance
- options: ClientOptions
Returns NotesAPI
Inherited from SubClient.constructor
- Defined in lib/SubClient.ts:11

Properties

`Protected` `Readonly`api

api: AxiosInstance

`Protected` `Readonly`options

options: ClientOptions

Methods

create

create(req: CreateRequest): Promise<CreateResponse>
Create a new note.
Parameters
- req: CreateRequest
  The create request.
Returns Promise<CreateResponse>
The create response.

Throws
AxiosError If the request fails.
- Defined in clients/Notes.ts:17

delete

delete(id: string, token?: string): Promise<void>
Delete a note.
Parameters
- id: string
  The note ID.
- Optionaltoken: string
  The deletion token, only required if request is from a different ip address.
Returns Promise<void>
Throws
AxiosError If the request fails.
- Defined in clients/Notes.ts:39

get

get(id: string): Promise<FetchResponse>
Get the note.
Parameters
- id: string
  The note ID.
Returns Promise<FetchResponse>
The note.

Throws
AxiosError If the request fails.
- Defined in clients/Notes.ts:28