> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md).

# Globals

## Index

### Enumerations

* [AffirmationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/affirmationstatus.md)
* [AuthorizationType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/authorizationtype.md)
* [CalendarUnit](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/calendarunit.md)
* [ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/claimtype.md)
* [ConditionTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/conditiontarget.md)
* [ConditionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/conditiontype.md)
* [CorporateActionKind](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/corporateactionkind.md)
* [CountryCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/countrycode.md)
* [ErrorCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/errorcode.md)
* [InstructionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/instructionstatus.md)
* [InstructionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/instructiontype.md)
* [KnownTokenType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/knowntokentype.md)
* [ProposalStage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/proposalstage.md)
* [RoleType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/roletype.md)
* [ScopeType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/scopetype.md)
* [StoBalanceStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/stobalancestatus.md)
* [StoSaleStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/stosalestatus.md)
* [StoTimingStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/stotimingstatus.md)
* [TargetTreatment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/targettreatment.md)
* [TickerReservationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/tickerreservationstatus.md)
* [TokenIdentifierType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/tokenidentifiertype.md)
* [TransactionArgumentType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/transactionargumenttype.md)
* [TransactionQueueStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/transactionqueuestatus.md)
* [TransactionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/transactionstatus.md)
* [TransferError](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/transfererror.md)
* [TransferRestrictionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/transferrestrictiontype.md)
* [TransferStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/transferstatus.md)
* [TxGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/txgroup.md)
* [VenueType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/venuetype.md)

### Classes

* [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/account.md)
* [AuthorizationRequest](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/authorizationrequest.md)
* [Authorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/authorizations.md)
* [Checkpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md)
* [CheckpointSchedule](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)
* [Checkpoints](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoints.md)
* [Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/claims.md)
* [Compliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/compliance.md)
* [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)
* [CorporateAction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/corporateaction.md)
* [CorporateActions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/corporateactions.md)
* [Count](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/count.md)
* [CurrentAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md)
* [CurrentIdentity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/currentidentity.md)
* [DefaultPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md)
* [DefaultTrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/defaulttrustedclaimissuer.md)
* [Distributions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/distributions.md)
* [DividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/dividenddistribution.md)
* [Documents](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/documents.md)
* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/entity.md)
* [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/identity.md)
* [IdentityAuthorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/identityauthorizations.md)
* [Instruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/instruction.md)
* [Issuance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/issuance.md)
* [Middleware](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/middleware.md)
* [NumberedPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)
* [Offerings](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/offerings.md)
* [Percentage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/percentage.md)
* [Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/polymesh.md)
* [PolymeshError](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/polymesherror.md)
* [PolymeshTransaction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/polymeshtransaction.md)
* [PolymeshTransactionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/polymeshtransactionbase.md)
* [PolymeshTransactionBatch](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/polymeshtransactionbatch.md)
* [Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md)
* [Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md)
* [Requirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/requirements.md)
* [Schedules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/schedules.md)
* [SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/securitytoken.md)
* [Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/settlements.md)
* [Sto](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/sto.md)
* [TickerReservation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/tickerreservation.md)
* [TokenHolders](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/tokenholders.md)
* [TransactionQueue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)
* [TransferRestrictionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transferrestrictionbase.md)
* [TransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transferrestrictions.md)
* [TrustedClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/trustedclaimissuers.md)
* [Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/venue.md)

### Interfaces

* [AccountData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/accountdata.md)
* [ActiveTransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/activetransferrestrictions.md)
* [AddBatchTransactionOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addbatchtransactionopts.md)
* [AddClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addclaimsparams.md)
* [AddInstructionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addinstructionparams.md)
* [AddInstructionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addinstructionsparams.md)
* [AddInvestorUniquenessClaimParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addinvestoruniquenessclaimparams.md)
* [AddTransactionOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addtransactionopts.md)
* [AddTransactionOptsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addtransactionoptsbase.md)
* [ArrayTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/arraytransactionargument.md)
* [Balance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/balance.md)
* [CalendarPeriod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/calendarperiod.md)
* [CddProviderRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/cddproviderrole.md)
* [CheckpointWithData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/checkpointwithdata.md)
* [ClaimClassicTickerParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimclassictickerparams.md)
* [ClaimData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimdata.md)
* [ClaimScope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimscope.md)
* [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimtarget.md)
* [ComplexTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/complextransactionargument.md)
* [ConditionCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/conditioncompliance.md)
* [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/connectparamsbase.md)
* [ConstructorParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/constructorparams.md)
* [ConsumeParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/consumeparams.md)
* [ControllerTransferParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/controllertransferparams.md)
* [CorporateActionDefaults](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/corporateactiondefaults.md)
* [CorporateActionTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/corporateactiontargets.md)
* [CountTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/counttransferrestriction.md)
* [CountTransferRestrictionInput](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/counttransferrestrictioninput.md)
* [CreateCheckpointScheduleParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/createcheckpointscheduleparams.md)
* [CreateSecurityTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/createsecuritytokenparams.md)
* [CreateVenueParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/createvenueparams.md)
* [DeletePortfolioParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/deleteportfolioparams.md)
* [DistributionParticipant](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/distributionparticipant.md)
* [DistributionPayment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/distributionpayment.md)
* [DistributionWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/distributionwithdetails.md)
* [DividendDistributionDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/dividenddistributiondetails.md)
* [DividendDistributionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/dividenddistributionparams.md)
* [EditClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/editclaimsparams.md)
* [EventIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/eventidentifier.md)
* [ExtrinsicData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/extrinsicdata.md)
* [Fees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/fees.md)
* [HistoricSettlement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/historicsettlement.md)
* [IdentityBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/identitybalance.md)
* [IdentityWithClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/identitywithclaims.md)
* [InstructionAffirmation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/instructionaffirmation.md)
* [InvestInStoParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/investinstoparams.md)
* [Investment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/investment.md)
* [InviteAccountParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/inviteaccountparams.md)
* [IssueTokensParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/issuetokensparams.md)
* [KeyringPair](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/keyringpair.md)
* [LeaveIdentityParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/leaveidentityparams.md)
* [Leg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/leg.md)
* [LinkCaDocsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/linkcadocsparams.md)
* [MiddlewareConfig](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/middlewareconfig.md)
* [ModifyCorporateActionsAgentParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/modifycorporateactionsagentparams.md)
* [ModifyInstructionAffirmationParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/modifyinstructionaffirmationparams.md)
* [ModifyPrimaryIssuanceAgentParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/modifyprimaryissuanceagentparams.md)
* [ModifySignerPermissionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/modifysignerpermissionsparams.md)
* [ModifyTokenTrustedClaimIssuersAddSetParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/modifytokentrustedclaimissuersaddsetparams.md)
* [ModifyTokenTrustedClaimIssuersRemoveParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/modifytokentrustedclaimissuersremoveparams.md)
* [MoveFundsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/movefundsparams.md)
* [NetworkProperties](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/networkproperties.md)
* [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md)
* [PayDividendsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/paydividendsparams.md)
* [PercentageTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/percentagetransferrestriction.md)
* [PercentageTransferRestrictionInput](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/percentagetransferrestrictioninput.md)
* [Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/permissions.md)
* [PermissionsLike](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/permissionslike.md)
* [PlainTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/plaintransactionargument.md)
* [PortfolioBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/portfoliobalance.md)
* [PortfolioCustodianRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/portfoliocustodianrole.md)
* [PortfolioMovement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/portfoliomovement.md)
* [ProcedureAuthorizationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/procedureauthorizationstatus.md)
* [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md)
* [ProposalDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proposaldetails.md)
* [ProposalTimeFrames](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proposaltimeframes.md)
* [ProposalVote](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proposalvote.md)
* [RedeemTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/redeemtokenparams.md)
* [RegisterIdentityParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/registeridentityparams.md)
* [RemoveCheckpointScheduleParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/removecheckpointscheduleparams.md)
* [RemoveCorporateActionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/removecorporateactionparams.md)
* [RemoveSecondaryKeysParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/removesecondarykeysparams.md)
* [RenamePortfolioParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/renameportfolioparams.md)
* [Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/requirement.md)
* [RequirementCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/requirementcompliance.md)
* [ReserveTickerParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/reservetickerparams.md)
* [ResultSet](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)
* [RevokeClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/revokeclaimsparams.md)
* [ScheduleDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/scheduledetails.md)
* [ScheduleWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/schedulewithdetails.md)
* [Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/scope.md)
* [SecondaryKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/secondarykey.md)
* [SecurityTokenDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/securitytokendetails.md)
* [SetAssetRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/setassetrequirementsparams.md)
* [SetCountTransferRestrictionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/setcounttransferrestrictionsparams.md)
* [SetCustodianParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/setcustodianparams.md)
* [SetPercentageTransferRestrictionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/setpercentagetransferrestrictionsparams.md)
* [SetTokenDocumentsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/settokendocumentsparams.md)
* [SettlementLeg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/settlementleg.md)
* [SimpleEnumTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/simpleenumtransactionargument.md)
* [StoDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/stodetails.md)
* [StoStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/stostatus.md)
* [StoTier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/stotier.md)
* [StoWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/stowithdetails.md)
* [TaxWithholding](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/taxwithholding.md)
* [TickerOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tickerownerrole.md)
* [TickerReservationDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tickerreservationdetails.md)
* [Tier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tier.md)
* [ToggleFreezeSecondaryKeysParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/togglefreezesecondarykeysparams.md)
* [ToggleFreezeStoParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/togglefreezestoparams.md)
* [ToggleFreezeTransfersParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/togglefreezetransfersparams.md)
* [TogglePauseRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/togglepauserequirementsparams.md)
* [TokenCaaRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokencaarole.md)
* [TokenDocument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokendocument.md)
* [TokenIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokenidentifier.md)
* [TokenOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokenownerrole.md)
* [TokenPiaRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokenpiarole.md)
* [TransferBreakdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transferbreakdown.md)
* [TransferPolyxParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transferpolyxparams.md)
* [TransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transferrestriction.md)
* [TransferRestrictionInputBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transferrestrictioninputbase.md)
* [TransferRestrictionResult](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transferrestrictionresult.md)
* [TransferTickerOwnershipParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transfertickerownershipparams.md)
* [TransferTokenOwnershipParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transfertokenownershipparams.md)
* [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/trustedclaimissuer.md)
* [UiKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/uikeyring.md)
* [UniqueIdentifiers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/uniqueidentifiers.md)
* [VenueDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/venuedetails.md)
* [VenueOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/venueownerrole.md)

### Type aliases

* [AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#accountbalance)
* [AddCountTransferRestrictionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#addcounttransferrestrictionparams)
* [AddPercentageTransferRestrictionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#addpercentagetransferrestrictionparams)
* [AddRestrictionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#addrestrictionparams)
* [ArgsType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#argstype)
* [Authorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#authorization)
* [CddClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#cddclaim)
* [CheckpointScheduleParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#checkpointscheduleparams)
* [Claim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim)
* [CommonKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#commonkeyring)
* [Condition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#condition)
* [ConditionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#conditionbase)
* [ConfigureDividendDistributionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#configuredividenddistributionparams)
* [Ensured](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#ensured)
* [GetReturnType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#getreturntype)
* [IdentityCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#identitycondition)
* [InputTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#inputtargets)
* [InputTaxWithholding](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#inputtaxwithholding)
* [InstructionDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#instructiondetails)
* [InvestorUniquenessClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#investoruniquenessclaim)
* [InvestorUniquenessV2Claim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#investoruniquenessv2claim)
* [ModifyCaDefaultsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#modifycadefaultsparams)
* [ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#modifyclaimsparams)
* [ModifyStoTimesParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#modifystotimesparams)
* [ModifyTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#modifytokenparams)
* [ModifyVenueParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#modifyvenueparams)
* [MultiClaimCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#multiclaimcondition)
* [Mutable](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#mutable)
* [NextKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#nextkey)
* [PortfolioLike](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#portfoliolike)
* [PrimaryIssuanceAgentCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#primaryissuanceagentcondition)
* [ProcedureFunc](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#procedurefunc)
* [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#role)
* [ScopedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#scopedclaim)
* [SetRestrictionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#setrestrictionsparams)
* [SetTransferRestrictionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#settransferrestrictionsparams)
* [Signer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#signer)
* [SingleClaimCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#singleclaimcondition)
* [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#subcallback)
* [TokenType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#tokentype)
* [TransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#transactionargument)
* [UnionOfProcedureFuncs](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#unionofprocedurefuncs)
* [UnscopedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#unscopedclaim)
* [UnsubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#unsubcallback)

### Variables

* [notExistsMessage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-notexistsmessage)

### Functions

* [areSameClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-aresameclaimissuers)
* [areSameClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-aresameclaims)
* [areSameTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-aresametargets)
* [convertArgsToRaw](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-convertargstoraw)
* [createProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#createproceduremethod)
* [findClaimsByOtherIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-findclaimsbyotherissuers)
* [findPositiveBalanceIuClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-findpositivebalanceiuclaims)
* [tickerToDid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#tickertodid)
* [tuple](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-tuple)
* [txGroupToTxTags](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#txgrouptotxtags)

### Object literals

* [defaultMessages](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#const-defaultmessages)

## Type aliases

### AccountBalance

Ƭ **AccountBalance**: [*Balance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/balance.md)

*Defined in* [*src/types/index.ts:599*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L599)

### AddCountTransferRestrictionParams

Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/counttransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:25*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/addTransferRestriction.ts#L25)

### AddPercentageTransferRestrictionParams

Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/percentagetransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:29*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/addTransferRestriction.ts#L29)

### AddRestrictionParams

Ƭ **AddRestrictionParams**: *Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:31*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L31)

### ArgsType

Ƭ **ArgsType**: *T extends function ? A : never*

*Defined in* [*src/types/utils/index.ts:20*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/utils/index.ts#L20)

Less strict version of Parameters

### Authorization

Ƭ **Authorization**: *object | object | object | object*

*Defined in* [*src/types/index.ts:733*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L733)

Authorization request data corresponding to type

### CddClaim

Ƭ **CddClaim**: *object*

*Defined in* [*src/types/index.ts:283*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L283)

#### Type declaration:

* **id**: *string*
* **type**: [*CustomerDueDiligence*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/claimtype.md#customerduediligence)

### CheckpointScheduleParams

Ƭ **CheckpointScheduleParams**: *Omit‹*[*UniqueIdentifiers*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/uniqueidentifiers.md) *& Params, "ticker"›*

*Defined in* [*src/api/entities/CheckpointSchedule/types.ts:8*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CheckpointSchedule/types.ts#L8)

### Claim

Ƭ **Claim**: [*ScopedClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#scopedclaim) *|* [*UnscopedClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#unscopedclaim)

*Defined in* [*src/types/index.ts:314*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L314)

### CommonKeyring

Ƭ **CommonKeyring**: *Pick‹Keyring, "getPair" | "getPairs" | "addFromSeed" | "addFromUri" | "addFromMnemonic"›*

*Defined in* [*src/types/index.ts:574*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L574)

### Condition

Ƭ **Condition**: [*SingleClaimCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#singleclaimcondition) *|* [*MultiClaimCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#multiclaimcondition) *|* [*IdentityCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#identitycondition) *|* [*PrimaryIssuanceAgentCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#primaryissuanceagentcondition)

*Defined in* [*src/types/index.ts:404*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L404)

### ConditionBase

Ƭ **ConditionBase**: *object*

*Defined in* [*src/types/index.ts:383*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L383)

#### Type declaration:

* **target**: [*ConditionTarget*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/conditiontarget.md)
* **trustedClaimIssuers**? : [*TrustedClaimIssuer*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/trustedclaimissuer.md)*\[]*

### ConfigureDividendDistributionParams

Ƭ **ConfigureDividendDistributionParams**: *Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object*

*Defined in* [*src/api/procedures/configureDividendDistribution.ts:59*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/configureDividendDistribution.ts#L59)

### Ensured

Ƭ **Ensured**: *Required‹Pick‹T, K››*

*Defined in* [*src/types/index.ts:567*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L567)

### GetReturnType

Ƭ **GetReturnType**: [*ActiveTransferRestrictions*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/activetransferrestrictions.md)*‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L45)

### IdentityCondition

Ƭ **IdentityCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:395*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L395)

### InputTargets

Ƭ **InputTargets**: *Omit‹*[*CorporateActionTargets*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/corporateactiontargets.md)*, "identities"› & object*

*Defined in* [*src/api/entities/CorporateAction/types.ts:20*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/types.ts#L20)

### InputTaxWithholding

Ƭ **InputTaxWithholding**: *Omit‹*[*TaxWithholding*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/taxwithholding.md)*, "identity"› & object*

*Defined in* [*src/api/entities/CorporateAction/types.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/types.ts#L24)

### InstructionDetails

Ƭ **InstructionDetails**: *object & object | object*

*Defined in* [*src/api/entities/Instruction/types.ts:15*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Instruction/types.ts#L15)

### InvestorUniquenessClaim

Ƭ **InvestorUniquenessClaim**: *object*

*Defined in* [*src/types/index.ts:285*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L285)

#### Type declaration:

* **cddId**: *string*
* **scope**: [*Scope*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/scope.md)
* **scopeId**: *string*
* **type**: [*InvestorUniqueness*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/claimtype.md#investoruniqueness)

### InvestorUniquenessV2Claim

Ƭ **InvestorUniquenessV2Claim**: *object*

*Defined in* [*src/types/index.ts:292*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L292)

#### Type declaration:

* **cddId**: *string*
* **type**: [*InvestorUniquenessV2*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/claimtype.md#investoruniquenessv2)

### ModifyCaDefaultsParams

Ƭ **ModifyCaDefaultsParams**: *object | object | object*

*Defined in* [*src/api/procedures/modifyCaDefaults.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyCaDefaults.ts#L24)

### ModifyClaimsParams

Ƭ **ModifyClaimsParams**: [*AddClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/addclaimsparams.md) *|* [*EditClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/editclaimsparams.md) *|* [*RevokeClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/revokeclaimsparams.md)

*Defined in* [*src/api/procedures/modifyClaims.ts:63*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyClaims.ts#L63)

### ModifyStoTimesParams

Ƭ **ModifyStoTimesParams**: *object | object | object*

*Defined in* [*src/api/procedures/modifyStoTimes.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyStoTimes.ts#L9)

### ModifyTokenParams

Ƭ **ModifyTokenParams**: *object | object | object | object*

*Defined in* [*src/api/procedures/modifyToken.ts:13*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyToken.ts#L13)

### ModifyVenueParams

Ƭ **ModifyVenueParams**: *object | object | object*

*Defined in* [*src/api/procedures/modifyVenue.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyVenue.ts#L9)

### MultiClaimCondition

Ƭ **MultiClaimCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:390*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L390)

### Mutable

Ƭ **Mutable**: *object*

*Defined in* [*src/types/utils/index.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/utils/index.ts#L3)

#### Type declaration:

### NextKey

Ƭ **NextKey**: *string | number | null*

*Defined in* [*src/types/index.ts:606*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L606)

### PortfolioLike

Ƭ **PortfolioLike**: *string |* [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/identity.md) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md) *|* [*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md) *| object*

*Defined in* [*src/types/index.ts:830*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L830)

### PrimaryIssuanceAgentCondition

Ƭ **PrimaryIssuanceAgentCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:400*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L400)

### ProcedureFunc

Ƭ **ProcedureFunc**: *function*

*Defined in* [*src/types/utils/index.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/utils/index.ts#L7)

#### Type declaration:

▸ (): *Procedure‹Args, ReturnValue, Storage›*

### Role

Ƭ **Role**: [*TickerOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tickerownerrole.md) *|* [*TokenOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokenownerrole.md) *|* [*TokenPiaRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokenpiarole.md) *|* [*TokenCaaRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/tokencaarole.md) *|* [*CddProviderRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/cddproviderrole.md) *|* [*VenueOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/venueownerrole.md) *|* [*PortfolioCustodianRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/portfoliocustodianrole.md)

*Defined in* [*src/types/index.ts:128*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L128)

### ScopedClaim

Ƭ **ScopedClaim**: *object |* [*InvestorUniquenessClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#investoruniquenessclaim) *| object*

*Defined in* [*src/types/index.ts:297*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L297)

### SetRestrictionsParams

Ƭ **SetRestrictionsParams**: *Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:38*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L38)

### SetTransferRestrictionsParams

Ƭ **SetTransferRestrictionsParams**: *object &* [*SetCountTransferRestrictionsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/setcounttransferrestrictionsparams.md) *|* [*SetPercentageTransferRestrictionsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/setpercentagetransferrestrictionsparams.md)

*Defined in* [*src/api/procedures/setTransferRestrictions.ts:40*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/setTransferRestrictions.ts#L40)

### Signer

Ƭ **Signer**: [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/identity.md) *|* [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/account.md)

*Defined in* [*src/types/index.ts:806*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L806)

### SingleClaimCondition

Ƭ **SingleClaimCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:385*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L385)

### SubCallback

Ƭ **SubCallback**: *function*

*Defined in* [*src/types/index.ts:563*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L563)

#### Type declaration:

▸ (`result`: T): *void | Promise‹void›*

**Parameters:**

| Name     | Type |
| -------- | ---- |
| `result` | T    |

### TokenType

Ƭ **TokenType**: [*KnownTokenType*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/knowntokentype.md) *| object*

*Defined in* [*src/types/index.ts:202*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L202)

Type of security that the token represents

### TransactionArgument

Ƭ **TransactionArgument**: *object &* [*PlainTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/plaintransactionargument.md) *|* [*ArrayTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/arraytransactionargument.md) *|* [*SimpleEnumTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/simpleenumtransactionargument.md) *|* [*ComplexTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/complextransactionargument.md)

*Defined in* [*src/types/index.ts:795*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L795)

### UnionOfProcedureFuncs

Ƭ **UnionOfProcedureFuncs**: *Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never*

*Defined in* [*src/types/utils/index.ts:13*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/utils/index.ts#L13)

### UnscopedClaim

Ƭ **UnscopedClaim**: *object |* [*CddClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#cddclaim) *|* [*InvestorUniquenessV2Claim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#investoruniquenessv2claim)

*Defined in* [*src/types/index.ts:312*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L312)

### UnsubCallback

Ƭ **UnsubCallback**: *function*

*Defined in* [*src/types/index.ts:565*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/index.ts#L565)

#### Type declaration:

▸ (): *void*

## Variables

### `Const` notExistsMessage

• **notExistsMessage**: *"Instruction no longer exists. This means it was already executed/rejected (execution might have failed)"* = "Instruction no longer exists. This means it was already executed/rejected (execution might have failed)"

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:27*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CheckpointSchedule/index.ts#L27)

*Defined in* [*src/api/entities/Instruction/index.ts:41*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Instruction/index.ts#L41)

## Functions

### `Const` areSameClaimIssuers

▸ **areSameClaimIssuers**(`currentClaimIssuers`: [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/trustedclaimissuer.md)\[], `claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]): *boolean*

*Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:71*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L71)

**Parameters:**

| Name                  | Type                                                                                                                             |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `currentClaimIssuers` | [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/trustedclaimissuer.md)\[] |
| `claimIssuers`        | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]                                                                      |

**Returns:** *boolean*

### `Const` areSameClaims

▸ **areSameClaims**(`claim`: [Claim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim), `__namedParameters`: object): *boolean*

*Defined in* [*src/api/procedures/modifyClaims.ts:74*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyClaims.ts#L74)

**Parameters:**

▪ **claim**: [*Claim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim)

▪ **\_\_namedParameters**: *object*

| Name    | Type                                                                                                                     |
| ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `scope` | undefined \| null \| [Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/scope.md) |
| `type`  | ClaimTypeEnum                                                                                                            |

**Returns:** *boolean*

### `Const` areSameTargets

▸ **areSameTargets**(`targets`: [CorporateActionTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/corporateactiontargets.md), `newTargets`: [InputTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#inputtargets)): *boolean*

*Defined in* [*src/api/procedures/modifyCaDefaults.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyCaDefaults.ts#L46)

**Parameters:**

| Name         | Type                                                                                                                                  |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| `targets`    | [CorporateActionTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/corporateactiontargets.md) |
| `newTargets` | [InputTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#inputtargets)                        |

**Returns:** *boolean*

### `Const` convertArgsToRaw

▸ **convertArgsToRaw**(`claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"], `rawTicker`: Ticker, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)): *object*

*Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:42*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L42)

**Parameters:**

| Name           | Type                                                                                                 |
| -------------- | ---------------------------------------------------------------------------------------------------- |
| `claimIssuers` | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]                                          |
| `rawTicker`    | Ticker                                                                                               |
| `context`      | [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md) |

**Returns:** *object*

* **claimIssuersToAdd**: *\[]\[]*
* **inputDids**: *string\[]*

### createProcedureMethod

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **Storage**›(`args`: object, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)): [*ProcedureMethod*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›*

*Defined in* [*src/utils/internal.ts:401*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/utils/internal.ts#L401)

Create a method that prepares a procedure

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

| Name                  | Type     |
| --------------------- | -------- |
| `getProcedureAndArgs` | function |

▪ **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)

**Returns:** [*ProcedureMethod*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›*

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **ReturnValue**, **Storage**›(`args`: object, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)): [*ProcedureMethod*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ReturnValue›*

*Defined in* [*src/utils/internal.ts:420*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/utils/internal.ts#L420)

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **ReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

| Name                  | Type     |
| --------------------- | -------- |
| `getProcedureAndArgs` | function |
| `transformer`         | function |

▪ **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)

**Returns:** [*ProcedureMethod*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ReturnValue›*

### `Const` findClaimsByOtherIssuers

▸ **findClaimsByOtherIssuers**(`claims`: [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimtarget.md)\[], `claimsByDid`: Record‹string, MiddlewareClaim\[]›): [*Claim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim)*\[]*

*Defined in* [*src/api/procedures/modifyClaims.ts:84*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyClaims.ts#L84)

**Parameters:**

| Name          | Type                                                                                                               |
| ------------- | ------------------------------------------------------------------------------------------------------------------ |
| `claims`      | [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimtarget.md)\[] |
| `claimsByDid` | Record‹string, MiddlewareClaim\[]›                                                                                 |

**Returns:** [*Claim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim)*\[]*

### `Const` findPositiveBalanceIuClaims

▸ **findPositiveBalanceIuClaims**(`claims`: [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimtarget.md)\[], `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)): *Promise‹*[*Claim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim)*\[]›*

*Defined in* [*src/api/procedures/modifyClaims.ts:100*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/procedures/modifyClaims.ts#L100)

**Parameters:**

| Name      | Type                                                                                                               |
| --------- | ------------------------------------------------------------------------------------------------------------------ |
| `claims`  | [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimtarget.md)\[] |
| `context` | [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context.md)               |

**Returns:** *Promise‹*[*Claim*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals.md#claim)*\[]›*

### tickerToDid

▸ **tickerToDid**(`ticker`: string): *string*

*Defined in* [*src/utils/conversion.ts:214*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/utils/conversion.ts#L214)

Generate a Security Token's DID from a ticker

**Parameters:**

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

**Returns:** *string*

### `Const` tuple

▸ **tuple**‹**T**›(...`args`: T): *T*

*Defined in* [*src/types/utils/index.ts:27*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/types/utils/index.ts#L27)

Create a literal tuple type from a list of arguments

**Type parameters:**

▪ **T**: *unknown\[]*

**Parameters:**

| Name      | Type | Description                 |
| --------- | ---- | --------------------------- |
| `...args` | T    | values to turn into a tuple |

**Returns:** *T*

### txGroupToTxTags

▸ **txGroupToTxTags**(`group`: [TxGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/txgroup.md)): *TxTag\[]*

*Defined in* [*src/utils/conversion.ts:579*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/utils/conversion.ts#L579)

Retrieve every Transaction Tag associated to a Transaction Group

**Parameters:**

| Name    | Type                                                                                               |
| ------- | -------------------------------------------------------------------------------------------------- |
| `group` | [TxGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/txgroup.md) |

**Returns:** *TxTag\[]*

## Object literals

### `Const` defaultMessages

### ▪ **defaultMessages**: *object*

*Defined in* [*src/base/PolymeshError.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/PolymeshError.ts#L3)

### \[ErrorCode.TransactionAborted]

• **\[ErrorCode.TransactionAborted]**: *string* = "The transaction was removed from the transaction pool. This might mean that it was malformed (nonce too large/nonce too small/duplicated or invalid transaction)"

*Defined in* [*src/base/PolymeshError.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/PolymeshError.ts#L7)

### \[ErrorCode.TransactionRejectedByUser]

• **\[ErrorCode.TransactionRejectedByUser]**: *string* = "The user canceled the transaction signature"

*Defined in* [*src/base/PolymeshError.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/PolymeshError.ts#L9)

### \[ErrorCode.TransactionReverted]

• **\[ErrorCode.TransactionReverted]**: *string* = "The transaction execution reverted due to an error"

*Defined in* [*src/base/PolymeshError.ts:6*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/PolymeshError.ts#L6)
