# Entity

Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality

## Type parameters

▪ **UniqueIdentifiers**

▪ **HumanReadable**

## Hierarchy

* **Entity**

  ↳ [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/identity)

  ↳ [Account](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/account)

  ↳ [TickerReservation](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/tickerreservation)

  ↳ [SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/securitytoken)

  ↳ [AuthorizationRequest](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/authorizationrequest)

  ↳ [Sto](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/sto)

  ↳ [Venue](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/venue)

  ↳ [Instruction](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/instruction)

  ↳ [Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/portfolio)

  ↳ [Checkpoint](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/checkpoint)

  ↳ [CheckpointSchedule](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/checkpointschedule)

  ↳ [PermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/permissiongroup)

  ↳ [CorporateAction](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/corporateaction)

## Index

### Properties

* [context](#protected-context)
* [uuid](#uuid)

### Methods

* [exists](#abstract-exists)
* [isEqual](#isequal)
* [toJson](#abstract-tojson)
* [generateUuid](#static-generateuuid)
* [isUniqueIdentifiers](#static-isuniqueidentifiers)
* [unserialize](#static-unserialize)

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L48)

***

### uuid

• **uuid**: *string*

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L46)

## Methods

### `Abstract` exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Entity.ts:68*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L68)

Determine whether this Entity exists on chain

**Returns:** *Promise‹boolean›*

***

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)‹unknown, unknown›): *boolean*

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L61)

Determine whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                              |
| -------- | ----------------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)‹unknown, unknown› |

**Returns:** *boolean*

***

### `Abstract` toJson

▸ **toJson**(): *HumanReadable*

*Defined in* [*src/api/entities/Entity.ts:73*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L73)

Returns Entity data in a human readable (JSON) format

**Returns:** *HumanReadable*

***

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

***

### `Static` isUniqueIdentifiers

▸ **isUniqueIdentifiers**(`identifiers`: unknown): *boolean*

*Defined in* [*src/api/entities/Entity.ts:42*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L42)

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

**Parameters:**

| Name          | Type    | Description          |
| ------------- | ------- | -------------------- |
| `identifiers` | unknown | object to type check |

**Returns:** *boolean*

***

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*