Class Entities

Hierarchy

TagoIOModule<GenericModuleParams>
- Entities

Index

Constructors

Methods

amount create delete deleteEntityData deleteField deleteIndex edit editEntityData editSchemaIndex emptyEntityData getEntityData info list renameField sendEntityData updateField

Constructors

constructor

new Entities(params: GenericModuleParams): Entities
Parameters
- params: GenericModuleParams
Returns Entities
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

amount

amount(entityID: string): Promise<number>
Parameters
- entityID: string
Returns Promise<number>
Description
Gets the total amount of data records stored in the entity.

See
https://help.tago.io/portal/en/kb/articles/entities Entities
Example
If receive an error "Authorization Denied", check policy Entity / Delete in Access Management.
```
const result = await Resources.entities.amount("entity-id-123");
console.log(result);
```
- Defined in modules/Resources/Entities.ts:148

create

create(entityObj: EntityCreateInfo): Promise<{ id: string }>
Parameters
- entityObj: EntityCreateInfo
Returns Promise<{ id: string }>
Description
Creates a new entity in the account.

See
https://help.tago.io/portal/en/kb/articles/entities#Creating_an_Entity Creating an Entity
Example
If receive an error "Authorization Denied", check policy Entity / Create in Access Management.
```
const result = await Resources.entities.create({
 name: "Temperature Sensors",
 schema: {
   temperature: { action: "create", type: "float", required: true } }
});
console.log(result); // { id: 'entity-id-123' }
```
- Defined in modules/Resources/Entities.ts:60

delete

delete(entityID: string): Promise<string>
Parameters
- entityID: string
Returns Promise<string>
Description
Permanently removes an entity from the account.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_fields Managing Fields
Example
If receive an error "Authorization Denied", check policy Entity / Delete in Access Management.
```
const result = await Resources.entities.delete("entity-id-123");
console.log(result); // Entity Successfully Removed
```
- Defined in modules/Resources/Entities.ts:104

deleteEntityData

deleteEntityData(
entityID: string,
itemsToDelete: { ids: string[] },
): Promise<string>
Parameters
- entityID: string
- itemsToDelete: { ids: string[] }
Returns Promise<string>
Description
Delete data records in a entity using the profile token and entity ID.

See the example to understand how to use this method properly to have full control on what to delete.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_the_data_in_your_Entity Managing the data in your Entity
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.entities.deleteEntityData("myEntityID", { ids: ["idOfTheRecord1"] });
console.log(result); // 1 item(s) deleted
```
- Defined in modules/Resources/Entities.ts:262

deleteField

deleteField(entityID: string, field: string): Promise<{ message: string }>
Parameters
- entityID: string
- field: string
Returns Promise<{ message: string }>
Description
Removes a field from the entity schema.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_fields Managing Fields
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.deleteField("entity-id-123", "old_field");
console.log(result); // { message: 'Entity Successfully Updated' }
```
- Defined in modules/Resources/Entities.ts:387

deleteIndex

deleteIndex(entityID: string, index: string): Promise<{ message: string }>
Parameters
- entityID: string
- index: string
Returns Promise<{ message: string }>
Description
Removes an index from the entity schema.

See
https://help.tago.io/portal/en/kb/articles/entities#Indexing_fields_to_improve_searching_and_sorting Indexing fields to improve searching and sorting
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.deleteIndex("entity-id-123", "temp_idx");
console.log(result); // { message: 'Entity Successfully Updated' }
```
- Defined in modules/Resources/Entities.ts:415

edit

edit(
entityID: string,
entityObj: Partial<EntityCreateInfo>,
): Promise<{ message: string }>
Parameters
- entityID: string
- entityObj: Partial<EntityCreateInfo>
Returns Promise<{ message: string }>
Description
Updates an existing entity's properties.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_fields Managing Fields
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.edit("entity-id-123", { name: "Updated Entity Name" });
console.log(result); // { message: 'Entity Successfully Updated' }
```
- Defined in modules/Resources/Entities.ts:82

editEntityData

editEntityData(
    entityID: string,
    updatedData:
        | { id: string } & Partial<EntityData>
        | ({ id: string } & Partial<EntityData>)[],
): Promise<string>
Parameters
- entityID: string
- updatedData: { id: string } & Partial<EntityData> | ({ id: string } & Partial<EntityData>)[]
Returns Promise<string>
Description
Updates existing data records in an entity.

The updatedData can be a single data record or an array of records to be updated, each of the records must have the id of the record and the fields to be updated.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_the_data_in_your_Entity Managing the data in your Entity
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.entities.editEntityData("entity-id-123", {
  id: "record-id-123",
  temperature: 30.1
});
console.log(result); // 1 item(s) updated
```
- Defined in modules/Resources/Entities.ts:210

editSchemaIndex

editSchemaIndex(
    entityID: string,
    data: {
        index?: Record<
            string,
            { action?: "create"; fields?: string[] }
            | { action?: "delete" },
        >;
        schema?: EntitySchema;
    },
): Promise<{ message: string }>
Parameters
- entityID: string
- data: {
      index?: Record<
          string,
          { action?: "create"; fields?: string[] }
          | { action?: "delete" },
      >;
      schema?: EntitySchema;
  }
Returns Promise<{ message: string }>
Description
Modifies the entity schema by adding new fields or managing indexes.

See
https://help.tago.io/portal/en/kb/articles/entities#Indexing_fields_to_improve_searching_and_sorting Indexing fields to improve searching and sorting
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.editSchemaIndex("entity-id-123", {
  schema: { unit: { action: "create", type: "float", required: false } },
  index: { temp_idx: { action: "create", fields: ["temperature"] } }
});
console.log(result); // { message: 'Entity Successfully Updated' }
```
- Defined in modules/Resources/Entities.ts:287

emptyEntityData

emptyEntityData(entityId: string): Promise<string>
Parameters
- entityId: string
Returns Promise<string>
Description
Removes all data records from an entity while preserving its structure and configuration.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_the_data_in_your_Entity Managing the data in your Entity
Example
If receive an error "Authorization Denied", check policy Entity / Delete in Access Management.
```
const result = await Resources.entities.emptyEntityData("entity-id-123");
console.log(result); // Data Successfully Removed
```
- Defined in modules/Resources/Entities.ts:443

getEntityData

getEntityData(
    entityID: string,
    queryParams?: EntityDataQuery,
    options?: { paramsSerializer?: any },
): Promise<EntityData[]>
Parameters
- entityID: string
- OptionalqueryParams: EntityDataQuery
- Optionaloptions: { paramsSerializer?: any }
Returns Promise<EntityData[]>
Description
Retrieves data records stored in a specific entity with optional filtering parameters.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_the_data_in_your_Entity Managing the data in your Entity
Example
If receive an error "Authorization Denied", check policy Entity / Access in Access Management.
```
const result = await Resources.entities.getEntityData("entity-id-123", { amount: 10, orderBy: "created_at,desc" });
console.log(result); // [ { id: 'record-id-123', created_at: 2025-01-22T13:45:30.913Z, ... }, ... ]

// Filtering by a specific field
const result = await Resources.entities.getEntityData("entity-id-123", {
  filter: { temperature: "30" },
  index: "temp_idx",
  amount: 9999,
});
console.log(result); // [ { id: 'record-id-123', created_at: 2025-01-22T13:45:30.913Z, ... }, ... ]
```
- Defined in modules/Resources/Entities.ts:177

info

info(entityID: string): Promise<EntityInfo>
Parameters
- entityID: string
Returns Promise<EntityInfo>
Description
Retrieves detailed information about a specific entity.

See
https://help.tago.io/portal/en/kb/articles/entities Entities
Example
If receive an error "Authorization Denied", check policy Entity / Access in Access Management.
```
const result = await Resources.entities.info("entity-id-123");
console.log(result); // { schema: { id: { type: 'uuid', required: true }, ... }, ... }
```
- Defined in modules/Resources/Entities.ts:125

list

list(
queryObj?: EntityQuery,
options?: { paramsSerializer?: any },
): Promise<EntityListItem[]>
Parameters
- OptionalqueryObj: EntityQuery
- Optionaloptions: { paramsSerializer?: any }
Returns Promise<EntityListItem[]>
Description
Retrieves a paginated list of all entities from the account with filtering and sorting options.

See
https://help.tago.io/portal/en/kb/articles/entities Entities
Example
If receive an error "Authorization Denied", check policy Entity / Access in Access Management.
```
const result = await Resources.entities.list({
  page: 1,
  fields: ["id", "name", "tags"],
  amount: 20
});
console.log(result); // [ { id: 'entity-id-123', name: 'test', tags: [] }, ... ]
```
- Defined in modules/Resources/Entities.ts:25

renameField

renameField(
    entityID: string,
    field: string,
    newName: string,
): Promise<{ message: string }>
Parameters
- entityID: string
- field: string
- newName: string
Returns Promise<{ message: string }>
Description
Renames a field in the entity schema.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_fields Managing Fields
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.renameField("entity-id-123", "old_name", "new_name");
console.log(result); // { message: 'Entity Successfully Updated' }
```
- Defined in modules/Resources/Entities.ts:326

sendEntityData

sendEntityData(
entityID: string,
data: EntityUnknownData | EntityUnknownData[],
): Promise<string>
Parameters
- entityID: string
- data: EntityUnknownData | EntityUnknownData[]
Returns Promise<string>
Description
Sends new data records to an entity.

The data can be a single data record or an array of records to be sent.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_the_data_in_your_Entity Managing the data in your Entity
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.sendEntityData("entity-id-123", { temperature: 25.5 });
console.log(result); // 1 Data Added
```
- Defined in modules/Resources/Entities.ts:237

updateField

updateField(
    entityID: string,
    field: string,
    data: Partial<EntitySchema>,
): Promise<{ message: string }>
Parameters
- entityID: string
- field: string
- data: Partial<EntitySchema>
Returns Promise<{ message: string }>
Description
Updates a field's configuration in the entity schema.

See
https://help.tago.io/portal/en/kb/articles/entities#Managing_fields Managing Fields
Example
If receive an error "Authorization Denied", check policy Entity / Edit in Access Management.
```
const result = await Resources.entities.updateField("entity-id-123", "temperature", { required: false });
console.log(result); // { message: 'Entity Successfully Updated' }
```
- Defined in modules/Resources/Entities.ts:355

Class Entities

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Entities

Methods

amount

Parameters

Returns Promise<number>

Description

See

Example

create

Parameters

Returns Promise<{ id: string }>

Description

See

Example

delete

Parameters

Returns Promise<string>

Description

See

Example

deleteEntityData

Parameters

Returns Promise<string>

Description

See

Example

deleteField

Parameters

Returns Promise<{ message: string }>

Description

See

Example

deleteIndex

Parameters

Returns Promise<{ message: string }>

Description

See

Example

edit

Parameters

Returns Promise<{ message: string }>

Description

See

Example

editEntityData

Parameters

Returns Promise<string>

Description

See

Example

editSchemaIndex

Parameters

Returns Promise<{ message: string }>

Description

See

Example

emptyEntityData

Parameters

Returns Promise<string>

Description

See

Example

getEntityData

Parameters

Returns Promise<EntityData[]>

Description

See

Example

info

Parameters

Returns Promise<EntityInfo>

Description