Class: FilesResource
Files Core
.delete(fileId): Promise<BaseOkay> 
1.0.0
DELETE /files/{file_id} 
Deletes a file
Parameters
| Name | Type | Description |
|---|---|---|
fileId | number | File identifier |
Returns
Promise<BaseOkay>
BaseDelete Delete response
Throws
If file ID is invalid
Example
javascript
await rest.files.delete(14);.get(fileId): Promise<File> 1.0.0
GET /files/{file_id}
Gets a file by identifier
Parameters
| Name | Type | Description |
|---|---|---|
fileId | number | File identifier |
Returns
Promise<File>
File object
Throws
If file ID is invalid
Example
javascript
const file = await rest.files.get(23);.getAll(page?): Promise<File[]> 1.0.0
GET /files
Gets all files
Parameters
| Name | Type | Description |
|---|---|---|
page? | number | Page number (optional) |
Returns
Promise<File[]>
Array of File objects
Throws
If page number is invalid
Example
javascript
const files = await rest.files.getAll();
const nextPage = await rest.files.getAll(1);.upload(file, filename?): Promise<File> 1.0.0
POST /files
Uploads a file from Blob, File, Buffer, or file path (Node.js only)
Parameters
| Name | Type | Description |
|---|---|---|
file | string | Blob | Buffer<ArrayBufferLike> | File, Blob, Buffer, or file path (string) |
filename? | string | Custom filename (required for Buffer/Blob, optional for path) |
Returns
Promise<File>
File Uploaded file
Throws
If input is invalid
Example
javascript
// Browser: Upload File from input
const fileInput = document.querySelector('input[type="file"]');
const file = await rest.files.upload(fileInput.files[0]);
// Browser: Upload Blob
const blob = new Blob(['content'], { type: 'text/plain' });
const file = await rest.files.upload(blob, 'document.txt');
// Node.js: Upload Buffer
const buffer = Buffer.from('content');
const file = await rest.files.upload(buffer, 'document.txt');
// Node.js: Upload from file path
const file = await rest.files.upload('./document.pdf');