# Offerings

Handles all Asset Offering related functionality

## Hierarchy

*   Namespace‹[Asset](asset)›

    ↳ **Offerings**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

• **context**: _Context_

_Inherited from void_

_Defined in_ [_src/api/entities/Namespace.ts:11_](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Namespace.ts#L11)

***

### `Protected` parent

• **parent**: [_Asset_](asset)

_Inherited from void_

_Defined in_ [_src/api/entities/Namespace.ts:9_](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Namespace.ts#L9)

## Methods

### get

▸ **get**(`opts`: object): _Promise‹_[_OfferingWithDetails_](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/offeringwithdetails.md)_\[]›_

_Defined in_ [_src/api/entities/Asset/Offerings.ts:81_](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/Offerings.ts#L81)

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

**Parameters:**

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

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

**Returns:** _Promise‹_[_OfferingWithDetails_](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/offeringwithdetails.md)_\[]›_

***

### getOne

▸ **getOne**(`args`: object): _Promise‹_[_Offering_](offering)_›_

_Defined in_ [_src/api/entities/Asset/Offerings.ts:56_](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/Offerings.ts#L56)

Retrieve a single Offering associated to this Asset by its ID

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

**Parameters:**

▪ **args**: _object_

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

**Returns:** _Promise‹_[_Offering_](offering)_›_

***

### launch

▸ **launch**(`args`: LaunchOfferingParams, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): _Promise‹_[_TransactionQueue_](transactionqueue)_‹_[_Offering_](offering)_››_

_Defined in_ [_src/api/entities/Asset/Offerings.ts:47_](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/Offerings.ts#L47)

Launch an Asset 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/beta/docs/interfaces/proceduremethod.md), which means you can call [launch.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

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

**Returns:** _Promise‹_[_TransactionQueue_](transactionqueue)_‹_[_Offering_](offering)_››_
