CorporateActions

Handles all Asset Corporate Actions related functionality

Hierarchy

• Namespace‹Asset›

  ↳ CorporateActions

Index

Properties

• context

• distributions

• parent

Methods

• getAgents

• getDefaultConfig

• remove

• removeAgent

• setAgent

• setDefaultConfig

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

---

distributions

• distributions: Distributions

Defined in src/api/entities/Asset/CorporateActions/index.ts:35

---

Protected parent

• parent: Asset

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

getAgents

▸ getAgents(): Promise‹Identity[]›

Defined in src/api/entities/Asset/CorporateActions/index.ts:125

Retrieve a list of agent Identities

Returns: Promise‹Identity[]›

---

getDefaultConfig

▸ getDefaultConfig(): Promise‹CorporateActionDefaultConfig›

Defined in src/api/entities/Asset/CorporateActions/index.ts:160

Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.

note This config is applied to every Corporate Action that is created until they are modified. Modifying the default config does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override this default config

Returns: Promise‹CorporateActionDefaultConfig›

---

remove

▸ remove(args: RemoveCorporateActionParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/CorporateActions/index.ts:118

Remove a Corporate Action

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	RemoveCorporateActionParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

removeAgent

▸ removeAgent(opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/CorporateActions/index.ts:108

Remove the Corporate Actions Agent of the Asset

note this action will leave the Asset owner as the Corporate Actions Agent

deprecated

note this method is of type NoArgsProcedureMethod, which means you can call removeAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

setAgent

▸ setAgent(args: ModifyCorporateActionsAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/CorporateActions/index.ts:94

Assign a new Corporate Actions Agent for the Asset

note this may create Authorization Requests which have to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

deprecated in favor of inviteAgent

note this method is of type ProcedureMethod, which means you can call setAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	ModifyCorporateActionsAgentParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

setDefaultConfig

▸ setDefaultConfig(args: ModifyCaDefaultConfigParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/CorporateActions/index.ts:78

Assign default config values(targets, global tax withholding percentage and per-Identity tax withholding percentages)

note These config values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these default config values

note this method is of type ProcedureMethod, which means you can call setDefaultConfig.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	ModifyCaDefaultConfigParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››