Class Exports

Index

Constructors

Methods

Constructors

constructor

new Exports(client: ObservationClient): Exports
Internal
Parameters
- client: ObservationClient
Returns Exports
- Defined in lib/exports.ts:15

Methods

list

list(): Promise<Paginated<Export>>
Fetches a list of the authenticated user's observation exports.

Returns Promise<Paginated<Export>>
A promise that resolves to a paginated list of the user's exports.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/exports.ts:26

get

get(exportId: number): Promise<Export>
Fetches the details of a single export by its ID. The export must belong to the authenticated user.
Parameters
- exportId: number
  The unique identifier for the export.
Returns Promise<Export>
A promise that resolves to the export object.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/exports.ts:39

start

start(options: StartExportOptions): Promise<ExportStartResponse>
Starts a new observation export job. This sends a request to the server to begin generating an export file. The status of the job can be tracked via the get method.
Parameters
- options: StartExportOptions
  The export options, specifying the type, format, and filters.
Returns Promise<ExportStartResponse>
A promise that resolves to an object containing the new export's ID and status URL.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/exports.ts:53