CorporateActions

Handles all Security Token Corporate Actions related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ CorporateActions

Index

Properties

• context

• distributions

• parent

• remove

• removeAgent

• setAgent

• setDefaults

Methods

• getAgent

• getDefaults

Properties

Protected context

• context: Context

Inherited from void

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

distributions

• distributions: Distributions

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

Protected parent

• parent: SecurityToken

Inherited from void

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

remove

• remove: ProcedureMethod‹RemoveCorporateActionParams, void›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:109

Remove a Corporate Action

note required role:

• Corporate Actions Agent

removeAgent

• removeAgent: ProcedureMethod‹void, void›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:101

Remove the Corporate Actions Agent of the Security Token

note this action will leave the Security Token owner as the Corporate Actions Agent

note required role:

• Security Token Owner

setAgent

• setAgent: ProcedureMethod‹ModifyCorporateActionsAgentParams, void›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:91

Assign a new Corporate Actions Agent for the Security Token

param identity to be set as Corporate Actions Agent

param date at which the authorization request to modify the Corporate Actions Agent expires (optional, never expires if a date is not provided)

note this may create AuthorizationRequests which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

• Security Token Owner

setDefaults

• setDefaults: ProcedureMethod‹ModifyCaDefaultsParams, void›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:76

Assign default values for targets, global tax withholding percentage and per-identity tax withholding perecentages.

note These 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 defaults

Methods

getAgent

▸ getAgent(): Promise‹Identity›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:114

Retrieve the Security Token's Corporate Actions agent

Returns: Promise‹Identity›

getDefaults

▸ getDefaults(): Promise‹CorporateActionDefaults›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:146

Retrieve default values for targets, global tax withholding percentage and per-identity tax withholding perecentages.

note These 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 defaults

Returns: Promise‹CorporateActionDefaults›