# Sto

Represents a Security Token Offering in the Polymesh blockchain

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)‹UniqueIdentifiers›

  ↳ **Sto**

## Index

### Properties

* [close](#close)
* [context](#protected-context)
* [freeze](#freeze)
* [id](#id)
* [modifyTimes](#modifytimes)
* [ticker](#ticker)
* [unfreeze](#unfreeze)
* [uuid](#uuid)

### Methods

* [details](#details)
* [getInvestments](#getinvestments)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### close

• **close**: *ProcedureMethod‹void, void›*

*Defined in* [*src/api/entities/Sto/index.ts:128*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L128)

Close the STO

### `Protected` context

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#protected-context)

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

### freeze

• **freeze**: *ProcedureMethod‹void,* [*Sto*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/sto)*›*

*Defined in* [*src/api/entities/Sto/index.ts:136*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L136)

Freeze the STO

**`note`** required role:

* Security Token Primary Issuance Agent

### id

• **id**: *BigNumber*

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

identifier number of the Offering

### modifyTimes

• **modifyTimes**: *ProcedureMethod‹*[*ModifyStoTimesParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals#modifystotimesparams)*, void›*

*Defined in* [*src/api/entities/Sto/index.ts:160*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L160)

Modify the start/end time of the STO

**`param`** new start time (optional, will be left the same if not passed)

**`param`** new end time (optional, will be left th same if not passed). A null value means the STO doesn't end

**`throws`** if:

* Trying to modify the start time on an STO that already started
* Trying to modify anything on an STO that already ended
* Trying to change start or end time to a past date

**`note`** required role:

* Security Token Primary Issuance Agent

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/Sto/index.ts:51*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L51)

ticker of the Security Token being offered

### unfreeze

• **unfreeze**: *ProcedureMethod‹void,* [*Sto*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/sto)*›*

*Defined in* [*src/api/entities/Sto/index.ts:144*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L144)

Unfreeze the STO

**`note`** required role:

* Security Token Primary Issuance Agent

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#uuid)

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

## Methods

### details

▸ **details**(): *Promise‹*[*StoDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stodetails)*›*

*Defined in* [*src/api/entities/Sto/index.ts:84*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L84)

Retrieve the STO's details

**`note`** can be subscribed to

**Returns:** *Promise‹*[*StoDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stodetails)*›*

▸ **details**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals#subcallback)‹[StoDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stodetails)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals#unsubcallback)*›*

*Defined in* [*src/api/entities/Sto/index.ts:85*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L85)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                  |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals#subcallback)‹[StoDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stodetails)› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals#unsubcallback)*›*

### getInvestments

▸ **getInvestments**(`opts`: object): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/resultset)*‹*[*Investment*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/investment)*››*

*Defined in* [*src/api/entities/Sto/index.ts:171*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Sto/index.ts#L171)

Retrieve all investments made on this STO

**`note`** supports pagination

**`note`** uses the middleware

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name     | Type                | Description |
| -------- | ------------------- | ----------- |
| `size?`  | undefined \| number | page size   |
| `start?` | undefined \| number | page offset |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/resultset)*‹*[*Investment*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/investment)*››*

### `Static` generateUuid

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#static-generateuuid)

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

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *string*

### `Static` unserialize

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#static-unserialize)

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

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *Identifiers*