Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • declarationDate
  • defaultTaxWithholding
  • description
  • id
  • Protected kind
  • targets
  • taxWithholdings
  • ticker
  • uuid
  • Methods
  • checkpoint
  • exists
  • isEqual
  • linkDocuments
  • modifyCheckpoint
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CorporateAction

PreviousContextNextCorporateActions

Last updated 3 years ago

Was this helpful?

Represents an action initiated by the issuer of a Security Token which may affect the positions of the Tokenholders

Hierarchy

  • ‹UniqueIdentifiers›

    ↳ CorporateAction

    ↳

Index

Properties

Methods

Properties

Protected context

declarationDate

• declarationDate: Date

date at which the Corporate Action was created

defaultTaxWithholding

• defaultTaxWithholding: BigNumber

default percentage of tax withholding for this Corporate Action

description

• description: string

brief text description of the Corporate Action

id

• id: BigNumber

internal Corporate Action ID

Protected kind

targets

tokenholder identities related to this Corporate action. If the treatment is Exclude, the identities are not targeted by the Action, and any identities left out of the array will be targeted, and vice versa

taxWithholdings

percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

ticker

• ticker: string

ticker of the Security Token

uuid

• uuid: string

Methods

checkpoint

Retrieve the Checkpoint associated with this Corporate Action. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead. A null value means the Corporate Action was created without an associated Checkpoint

exists

▸ exists(): Promise‹boolean›

Retrieve whether the Corporate Action exists

Returns: Promise‹boolean›

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

linkDocuments

Link a list of documents to this corporate action

note any previous links are removed in favor of the new list

note required role:

  • Corporate Actions Agent

Parameters:

Name

Type

args

modifyCheckpoint

Modify the Corporate Action's Checkpoint

Parameters:

Name

Type

args

ModifyCaCheckpointParams

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

• context:

Inherited from .

Defined in

Defined in

Defined in

Defined in

Defined in

• kind:

Defined in

• targets:

Defined in

• taxWithholdings: []

Defined in

Defined in

Inherited from .

Defined in

▸ checkpoint(): Promise‹ | | null›

Defined in

Returns: Promise‹ | | null›

Defined in

▸ isEqual(entity: ‹unknown›): boolean

Inherited from .

Defined in

‹unknown›

▸ linkDocuments(args: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call linkDocuments.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ modifyCheckpoint(args: ModifyCaCheckpointParams): Promise‹‹void››

Defined in

note this method is of type , which means you can call modifyCheckpoint.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

Context
src/api/entities/Entity.ts:48
src/api/entities/CorporateAction/index.ts:70
src/api/entities/CorporateAction/index.ts:86
src/api/entities/CorporateAction/index.ts:75
src/api/entities/CorporateAction/index.ts:60
CorporateActionKind
src/api/entities/CorporateAction/index.ts:94
CorporateActionTargets
src/api/entities/CorporateAction/index.ts:81
TaxWithholding
src/api/entities/CorporateAction/index.ts:92
src/api/entities/CorporateAction/index.ts:65
src/api/entities/Entity.ts:46
Checkpoint
CheckpointSchedule
src/api/entities/CorporateAction/index.ts:177
Checkpoint
CheckpointSchedule
src/api/entities/CorporateAction/index.ts:166
Entity
src/api/entities/Entity.ts:61
LinkCaDocsParams
TransactionQueue
src/api/entities/CorporateAction/index.ts:149
ProcedureMethod
TransactionQueue
TransactionQueue
src/api/entities/CorporateAction/index.ts:159
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
DividendDistribution
context
declarationDate
defaultTaxWithholding
description
id
kind
targets
taxWithholdings
ticker
uuid
checkpoint
exists
isEqual
linkDocuments
modifyCheckpoint
generateUuid
unserialize
Entity
LinkCaDocsParams
CheckpointSchedule
CheckpointSchedule
CheckpointSchedule
CheckpointSchedule
CheckpointSchedule
context
uuid
isEqual
generateUuid
unserialize