Appearance
Files
File management: listing, file properties and metadata, tags, removal, and uploads.
Endpoints
| Endpoint | Arguments | Returns |
|---|---|---|
files.get_file_properties | ObjectId | unknown |
files.list | unknown | object |
files.my_files | - | object |
files.remove_files | unknown | boolean |
files.set_file_metadata | options, options | unknown |
files.set_file_properties | options | boolean |
files.tags.add | fileId, unknown, WorkspaceId | string[] |
files.tags.remove | fileId, unknown, WorkspaceId | string[] |
files.upload | content: Base64String | Buffer, filename: string, section?: "process_cover_picture" | "discussion_cover_picture" | "logo" | object |
files.get_file_properties
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.get_file_properties', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.list
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (any \| ObjectId \| ObjectId[], optional):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.list', [
'...', // argument 1
]);
console.log(result);Returns
Record<string, any>
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.my_files
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Undocumented
This endpoint declares no argument schema in the source yet.
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.my_files', []);
console.log(result);Returns
Record<string, any>
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.remove_files
Description
Removes selected fiels, provided the user has the correct permissions.
Parameters
Argument 1 (ObjectId[], optional):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.remove_files', [
['507f1f77bcf86cd799439011'],
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.set_file_metadata
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
file_id | ObjectId | yes |
Argument 2 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
profilepic | boolean | no |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.set_file_metadata', [
{
file_id: '507f1f77bcf86cd799439011',
},
{
profilepic: false,
},
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.set_file_properties
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | |
fileSets | ObjectId[] | no | |
profilepic | boolean | no | |
typeContent | string | no | |
isVideo | boolean | no | |
isPicture | boolean | no | |
isPublic | boolean | no | |
_id | ObjectId | yes |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.set_file_properties', [
{
_id: '507f1f77bcf86cd799439011',
},
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.tags.add
Description
Adds one or more case-sensitive tags to a file. Duplicates against existing tags are ignored.
Parameters
Argument 1 (fileId, required): File ID
Argument 2 (string[], required): Tags to add
Argument 3 (WorkspaceId, optional): Workspace (company) ID; when provided, scopes the guest check and the files.update broadcast
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.tags.add', [
'507f1f77bcf86cd799439011', // fileId (required)
['string'],
'507f1f77bcf86cd799439011', // WorkspaceId
]);
console.log(result);Returns
Array of string.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.tags.remove
Description
Removes one or more tags from a file by case-sensitive exact match. Tags not present are silently ignored.
Parameters
Argument 1 (fileId, required): File ID
Argument 2 (string[], required): Tags to remove
Argument 3 (WorkspaceId, optional): Workspace (company) ID; when provided, scopes the guest check and the files.update broadcast
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.tags.remove', [
'507f1f77bcf86cd799439011', // fileId (required)
['string'],
'507f1f77bcf86cd799439011', // WorkspaceId
]);
console.log(result);Returns
Array of string.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
files.upload
Description
Upload a file
Parameters
Argument 1 (object \| string, optional): content Binary or Base64String
Argument 2 (string, optional): name
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('files.upload', [
{ /* ... */ }, // content `Binary or Base64String`
'string', // name
]);
console.log(result);Returns
| Field | Type | Required | Description |
|---|---|---|---|
_id | ObjectId | yes | fileId |
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.