# Offerings

Handles all Security Token Offering related functionality

## Hierarchy

* Namespace‹[SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/securitytoken)›

  ↳ **Offerings**

## Index

### Properties

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

### Methods

* [get](#get)
* [getOne](#getone)
* [launch](#launch)

## Properties

### `Protected` context

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

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Namespace.ts#L11)

***

### `Protected` parent

• **parent**: [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/securitytoken)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Namespace.ts#L9)

## Methods

### get

▸ **get**(`opts`: object): *Promise‹*[*StoWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stowithdetails.md)*\[]›*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/SecurityToken/Offerings.ts#L81)

Retrieve all of the Token's Offerings and their details. Can be filtered using parameters

**Parameters:**

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

| Name      | Type                                                                                                             | Description                                                                                            |
| --------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `status?` | Partial‹[StoStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stostatus.md)› | status of the offerings to fetch. If defined, only STOs that have all passed statuses will be returned |

**Returns:** *Promise‹*[*StoWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stowithdetails.md)*\[]›*

***

### getOne

▸ **getOne**(`args`: object): *Promise‹*[*Sto*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/sto)*›*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:56*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/SecurityToken/Offerings.ts#L56)

Retrieve a single Offering associated to this Security Token by its ID

**`throws`** if there is no Offering with the passed ID

**Parameters:**

▪ **args**: *object*

| Name | Type      |
| ---- | --------- |
| `id` | BigNumber |

**Returns:** *Promise‹*[*Sto*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/sto)*›*

***

### launch

▸ **launch**(`args`: LaunchStoParams, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹*[*Sto*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/sto)*››*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:47*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/SecurityToken/Offerings.ts#L47)

Launch a Security Token Offering

**`note`** required roles:

* Offering Portfolio Custodian
* Raising Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `launch.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                            |
| ------- | --------------------------------------------------------------------------------------------------------------- |
| `args`  | LaunchStoParams                                                                                                 |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹*[*Sto*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/sto)*››*