Class DatasetsResource

Index

Constructors

Methods

list get create upload delete updateStatus download

Constructors

constructor

new DatasetsResource(_client: Client): DatasetsResource
Parameters
- _client: Client
Returns DatasetsResource
- Defined in resources/datasets.ts:41

Methods

list

list(params?: ListDatasetsParams): Promise<PaginatedResponse<{}>>
List datasets
Parameters
- Optionalparams: ListDatasetsParams
Returns Promise<PaginatedResponse<{}>>
- Defined in resources/datasets.ts:46

get

get(id: string, download?: boolean): Promise<{}>
Get dataset details
Parameters
- id: string
- download: boolean = false
Returns Promise<{}>
- Defined in resources/datasets.ts:70

create

create(data: {}): Promise<{}>
Create a new dataset
Parameters
- data: {}
Returns Promise<{}>
- Defined in resources/datasets.ts:93

upload

upload(file: FileInput, metadata: DatasetMetadata): Promise<{}>
Upload a file as a dataset
Parameters
- file: FileInput
- metadata: DatasetMetadata
Returns Promise<{}>
- Defined in resources/datasets.ts:113

delete

delete(id: string): Promise<void>
Delete a dataset
Parameters
- id: string
Returns Promise<void>
- Defined in resources/datasets.ts:194

updateStatus

updateStatus(id: string, status: "unlisted" | "listed"): Promise<{}>
Update dataset status
Parameters
- id: string
- status: "unlisted" | "listed"
Returns Promise<{}>
- Defined in resources/datasets.ts:212

download

download(id: string): Promise<{}>
Download dataset file
Parameters
- id: string
Returns Promise<{}>
- Defined in resources/datasets.ts:233