# SimpleSto

Class used to manage a simple sto

## Hierarchy

↳ [Sto](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)‹[Params](https://developers.polymath.network/classic-sdk/interfaces/_entities_simplesto_.params)›

↳ **SimpleSto**

## Index

### Constructors

* [constructor](#constructor)

### Properties

* [address](#address)
* [beneficialInvestmentsAllowed](#beneficialinvestmentsallowed)
* [cap](#cap)
* [capReached](#capreached)
* [context](#protected-context)
* [endDate](#enddate)
* [fundraiseCurrencies](#fundraisecurrencies)
* [investorCount](#investorcount)
* [isFinalized](#isfinalized)
* [isPaused](#ispaused)
* [preIssueAllowed](#preissueallowed)
* [raisedAmount](#raisedamount)
* [raisedFundsWallet](#raisedfundswallet)
* [rate](#rate)
* [securityTokenId](#securitytokenid)
* [securityTokenSymbol](#securitytokensymbol)
* [soldTokensAmount](#soldtokensamount)
* [startDate](#startdate)
* [stoType](#stotype)
* [uid](#uid)
* [unsoldTokensWallet](#unsoldtokenswallet)

### Methods

* [\_refresh](#_refresh)
* [allowBeneficialInvestments](#allowbeneficialinvestments)
* [allowPreIssuing](#allowpreissuing)
* [assignRole](#assignrole)
* [disallowBeneficialInvestments](#disallowbeneficialinvestments)
* [disallowPreIssuing](#disallowpreissuing)
* [finalize](#finalize)
* [getInvestments](#getinvestments)
* [invest](#invest)
* [pause](#pause)
* [revokeRole](#revokerole)
* [toPojo](#topojo)
* [unpause](#unpause)
* [generateId](#static-generateid)
* [unserialize](#static-unserialize)

## Constructors

### constructor

\+ **new SimpleSto**(`params`: [Params](https://developers.polymath.network/classic-sdk/interfaces/_entities_simplesto_.params) & [UniqueIdentifiers](https://developers.polymath.network/classic-sdk/interfaces/_entities_sto_.uniqueidentifiers), `context`: [Context](https://developers.polymath.network/classic-sdk/classes/_context_.context)): [*SimpleSto*](https://developers.polymath.network/classic-sdk/classes/_entities_simplesto_.simplesto)

*Overrides* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*constructor*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#constructor)

*Defined in* [*src/entities/SimpleSto.ts:61*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61)

Create a new simple sto instance

**Parameters:**

| Name      | Type                                                                                                                                                                                                                |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `params`  | [Params](https://developers.polymath.network/classic-sdk/interfaces/_entities_simplesto_.params) & [UniqueIdentifiers](https://developers.polymath.network/classic-sdk/interfaces/_entities_sto_.uniqueidentifiers) |
| `context` | [Context](https://developers.polymath.network/classic-sdk/classes/_context_.context)                                                                                                                                |

**Returns:** [*SimpleSto*](https://developers.polymath.network/classic-sdk/classes/_entities_simplesto_.simplesto)

## Properties

### address

• **address**: *string*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*address*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#address)

*Defined in* [*src/entities/Sto.ts:107*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107)

ethereum address for the STO

### beneficialInvestmentsAllowed

• **beneficialInvestmentsAllowed**: *boolean*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*beneficialInvestmentsAllowed*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#beneficialinvestmentsallowed)

*Defined in* [*src/entities/Sto.ts:175*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175)

whether investments can be made on behalf of a beneficiary or not

### cap

• **cap**: *BigNumber*

*Defined in* [*src/entities/SimpleSto.ts:56*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L56)

cap of total tokens that can be sold in sto

### capReached

• **capReached**: *boolean*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*capReached*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#capreached)

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

whether the STO cap has been reached or not

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/classic-sdk/classes/_context_.context)

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*context*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#protected-context)

*Defined in* [*src/entities/Sto.ts:177*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177)

### endDate

• **endDate**: *Date*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*endDate*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#enddate)

*Defined in* [*src/entities/Sto.ts:120*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120)

### fundraiseCurrencies

• **fundraiseCurrencies**: *Currency\[]*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*fundraiseCurrencies*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#fundraisecurrencies)

*Defined in* [*src/entities/Sto.ts:150*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150)

types of currency in which funds can be raised

### investorCount

• **investorCount**: *number*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*investorCount*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#investorcount)

*Defined in* [*src/entities/Sto.ts:145*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145)

number of investors that have purchased tokens in the STO

### isFinalized

• **isFinalized**: *boolean*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*isFinalized*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#isfinalized)

*Defined in* [*src/entities/Sto.ts:165*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165)

whether the STO has been finalized or not

### isPaused

• **isPaused**: *boolean*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*isPaused*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#ispaused)

*Defined in* [*src/entities/Sto.ts:155*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155)

whether the STO is currently paused or not

### preIssueAllowed

• **preIssueAllowed**: *boolean*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*preIssueAllowed*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#preissueallowed)

*Defined in* [*src/entities/Sto.ts:170*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170)

whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made

### raisedAmount

• **raisedAmount**: *BigNumber*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*raisedAmount*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#raisedamount)

*Defined in* [*src/entities/Sto.ts:135*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135)

amount of funds that have been raised so far

### raisedFundsWallet

• **raisedFundsWallet**: *string*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*raisedFundsWallet*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#raisedfundswallet)

*Defined in* [*src/entities/Sto.ts:125*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125)

wallet where raised funds will be forwarded to

### rate

• **rate**: *BigNumber*

*Defined in* [*src/entities/SimpleSto.ts:61*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61)

rate at which the tokens will be sold in sto

### securityTokenId

• **securityTokenId**: *string*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*securityTokenId*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#securitytokenid)

*Defined in* [*src/entities/Sto.ts:111*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111)

### securityTokenSymbol

• **securityTokenSymbol**: *string*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*securityTokenSymbol*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#securitytokensymbol)

*Defined in* [*src/entities/Sto.ts:109*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109)

### soldTokensAmount

• **soldTokensAmount**: *BigNumber*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*soldTokensAmount*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#soldtokensamount)

*Defined in* [*src/entities/Sto.ts:140*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140)

total number of tokens that have been sold so far

### startDate

• **startDate**: *Date*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*startDate*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#startdate)

*Defined in* [*src/entities/Sto.ts:118*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118)

### stoType

• **stoType**: [*StoType*](https://developers.polymath.network/classic-sdk/enums/_types_index_.stotype)

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*stoType*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#stotype)

*Defined in* [*src/entities/Sto.ts:116*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116)

type of STO setup

### uid

• **uid**: *string*

*Overrides* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*uid*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#abstract-uid)

*Defined in* [*src/entities/SimpleSto.ts:51*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L51)

unique generated Tiered STO id

### unsoldTokensWallet

• **unsoldTokensWallet**: *string*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*unsoldTokensWallet*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#unsoldtokenswallet)

*Defined in* [*src/entities/Sto.ts:130*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130)

wallet where unsold tokens will be returned to

## Methods

### \_refresh

▸ **\_refresh**(`params`: Partial‹[Params](https://developers.polymath.network/classic-sdk/interfaces/_entities_simplesto_.params)›): *void*

*Overrides* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*\_refresh*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#_refresh)

*Defined in* [*src/entities/SimpleSto.ts:151*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L151)

Hydrate the entity

**Parameters:**

| Name     | Type                                                                                                      |
| -------- | --------------------------------------------------------------------------------------------------------- |
| `params` | Partial‹[Params](https://developers.polymath.network/classic-sdk/interfaces/_entities_simplesto_.params)› |

**Returns:** *void*

### allowBeneficialInvestments

▸ **allowBeneficialInvestments**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowBeneficialInvestmentsProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:316*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316)

Enable a party to invest in the STO on behalf of another party

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowBeneficialInvestmentsProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs)*, void››*

### allowPreIssuing

▸ **allowPreIssuing**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowPreIssuingProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowpreissuingprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:287*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287)

Enable all offered tokens to be issued instantly at STO start (default behavior is to issue on purchase) Can be disabled *BEFORE* the STO starts by calling disallowPreIssuing

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowPreIssuingProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowpreissuingprocedureargs)*, void››*

### assignRole

▸ **assignRole**(`args`: object): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*AssignStoRoleProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.assignstoroleprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:348*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348)

Assign a role on the STO to a delegate

**Parameters:**

▪ **args**: *object*

| Name              | Type                                                                                   |
| ----------------- | -------------------------------------------------------------------------------------- |
| `delegateAddress` | string                                                                                 |
| `description?`    | undefined \| string                                                                    |
| `role`            | [StoRole](https://developers.polymath.network/classic-sdk/enums/_types_index_.storole) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*AssignStoRoleProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.assignstoroleprocedureargs)*, void››*

### disallowBeneficialInvestments

▸ **disallowBeneficialInvestments**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowBeneficialInvestmentsProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:330*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330)

Disable the possibility for a party to invest in the STO on behalf of another party

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowBeneficialInvestmentsProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs)*, void››*

### disallowPreIssuing

▸ **disallowPreIssuing**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowPreIssuingProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowpreissuingprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:302*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302)

Disable pre-issuing of offered tokens at STO start (goes back to default behavior, which is to issue on purchase) Can be re-enabled *BEFORE* the STO starts by calling allowPreIssuing

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*ToggleAllowPreIssuingProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.toggleallowpreissuingprocedureargs)*, void››*

### finalize

▸ **finalize**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*FinalizeStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.finalizestoprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:275*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275)

Finalize the offering. The offering's treasury wallet (or the Security Token's treasury wallet if one was not specified for the offering) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*FinalizeStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.finalizestoprocedureargs)*, void››*

### getInvestments

▸ **getInvestments**(): *Promise‹*[*Investment*](https://developers.polymath.network/classic-sdk/classes/_entities_investment_.investment)*\[]›*

*Defined in* [*src/entities/SimpleSto.ts:81*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L81)

Retrieve all investments that have been made on this STO

**Returns:** *Promise‹*[*Investment*](https://developers.polymath.network/classic-sdk/classes/_entities_investment_.investment)*\[]›*

### invest

▸ **invest**(`args`: object): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*InvestInSimpleStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.investinsimplestoprocedureargs)*, void››*

*Defined in* [*src/entities/SimpleSto.ts:126*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L126)

Invest in the STO

**Parameters:**

▪ **args**: *object*

| Name           | Type                | Description                                                                                                                                                                              |
| -------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount`       | BigNumber           | amount to spend                                                                                                                                                                          |
| `beneficiary?` | undefined \| string | address that will receive the purchased tokens (defaults to current wallet, will fail if beneficial investments are not allowed for the STO, only applicable if the STO currency is ETH) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*InvestInSimpleStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.investinsimplestoprocedureargs)*, void››*

### pause

▸ **pause**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*TogglePauseStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.togglepausestoprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:246*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246)

Pause the offering

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*TogglePauseStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.togglepausestoprocedureargs)*, void››*

### revokeRole

▸ **revokeRole**(`args`: object): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*AssignStoRoleProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.assignstoroleprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:374*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374)

Remove a role from a delegate

**Parameters:**

▪ **args**: *object*

| Name              | Type                                                                                   |
| ----------------- | -------------------------------------------------------------------------------------- |
| `delegateAddress` | string                                                                                 |
| `role`            | [StoRole](https://developers.polymath.network/classic-sdk/enums/_types_index_.storole) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*AssignStoRoleProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.assignstoroleprocedureargs)*, void››*

### toPojo

▸ **toPojo**(): *object*

*Overrides* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*toPojo*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#topojo)

*Defined in* [*src/entities/SimpleSto.ts:137*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L137)

Convert entity to a POJO (Plain Old Javascript Object)

**Returns:** *object*

* **cap**: *BigNumber*
* **rate**: *BigNumber*

### unpause

▸ **unpause**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*TogglePauseStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.togglepausestoprocedureargs)*, void››*

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)

*Defined in* [*src/entities/Sto.ts:260*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260)

Unpause the offering

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/classes/_entities_transactionqueue_.transactionqueue)*‹*[*TogglePauseStoProcedureArgs*](https://developers.polymath.network/classic-sdk/interfaces/_types_index_.togglepausestoprocedureargs)*, void››*

### `Static` generateId

▸ **generateId**(`__namedParameters`: object): *string*

*Defined in* [*src/entities/SimpleSto.ts:40*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L40)

Generate the Simple STO's UUID from its identifying properties

**Parameters:**

▪ **\_\_namedParameters**: *object*

| Name              | Type                                                                                   |
| ----------------- | -------------------------------------------------------------------------------------- |
| `address`         | string                                                                                 |
| `securityTokenId` | string                                                                                 |
| `stoType`         | [StoType](https://developers.polymath.network/classic-sdk/enums/_types_index_.stotype) |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**(`serialized`: string): [*UniqueIdentifiers*](https://developers.polymath.network/classic-sdk/interfaces/_entities_sto_.uniqueidentifiers)

*Inherited from* [*Sto*](https://developers.polymath.network/classic-sdk/classes/_entities_sto_.sto)*.*[*unserialize*](https://developers.polymath.network/classic-sdk/_entities_sto_.sto#static-unserialize)

*Defined in* [*src/entities/Sto.ts:184*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184)

Unserialize string to a Security Token Offering object representation

**Parameters:**

| Name         | Type   |
| ------------ | ------ |
| `serialized` | string |

**Returns:** [*UniqueIdentifiers*](https://developers.polymath.network/classic-sdk/interfaces/_entities_sto_.uniqueidentifiers)
