Class AnnotationsResource

Index

Constructors

Methods

list create get update delete

Constructors

constructor

new AnnotationsResource(_client: Client): AnnotationsResource
Parameters
- _client: Client
Returns AnnotationsResource
- Defined in resources/annotations.ts:42

Methods

list

list(params?: AnnotationListParams): Promise<PaginatedResponse<{}>>
Parameters
- params: AnnotationListParams = {}
Returns Promise<PaginatedResponse<{}>>
- Defined in resources/annotations.ts:44

create

create(data: CreateAnnotationData): Promise<{}>
Parameters
- data: CreateAnnotationData
Returns Promise<{}>
- Defined in resources/annotations.ts:63

get

get(id: string): Promise<{}>
Parameters
- id: string
Returns Promise<{}>
- Defined in resources/annotations.ts:93

update

update(id: string, data: UpdateAnnotationData): Promise<{}>
Parameters
- id: string
- data: UpdateAnnotationData
Returns Promise<{}>
- Defined in resources/annotations.ts:108

delete

delete(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in resources/annotations.ts:124