> 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/v11.0.2/globals.md).

# Globals

## Index

### Enumerations

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

### Classes

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

### Interfaces

* [ActiveTransferRestrictions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/activetransferrestrictions.md)
* [AddBatchTransactionOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addbatchtransactionopts.md)
* [AddClaimsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addclaimsparams.md)
* [AddInstructionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addinstructionparams.md)
* [AddInstructionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addinstructionsparams.md)
* [AddInvestorUniquenessClaimParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addinvestoruniquenessclaimparams.md)
* [AddPairBaseParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addpairbaseparams.md)
* [AddTransactionOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addtransactionopts.md)
* [AddTransactionOptsBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addtransactionoptsbase.md)
* [AgentWithGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/agentwithgroup.md)
* [ArrayTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/arraytransactionargument.md)
* [Balance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/balance.md)
* [CalendarPeriod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/calendarperiod.md)
* [CddProviderRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/cddproviderrole.md)
* [CheckpointWithData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/checkpointwithdata.md)
* [ClaimClassicTickerParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimclassictickerparams.md)
* [ClaimData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)
* [ClaimScope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimscope.md)
* [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimtarget.md)
* [ComplexTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/complextransactionargument.md)
* [ConditionCompliance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/conditioncompliance.md)
* [ConnectParamsBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/connectparamsbase.md)
* [ConstructorParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/constructorparams.md)
* [ConsumeParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/consumeparams.md)
* [ControllerTransferParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/controllertransferparams.md)
* [CorporateActionDefaults](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/corporateactiondefaults.md)
* [CorporateActionTargets](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/corporateactiontargets.md)
* [CountTransferRestriction](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/counttransferrestriction.md)
* [CountTransferRestrictionInput](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/counttransferrestrictioninput.md)
* [CreateCheckpointScheduleParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/createcheckpointscheduleparams.md)
* [CreateGroupParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/creategroupparams.md)
* [CreateSecurityTokenParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/createsecuritytokenparams.md)
* [CreateVenueParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/createvenueparams.md)
* [DeletePortfolioParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/deleteportfolioparams.md)
* [DistributionParticipant](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionparticipant.md)
* [DistributionPayment](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionpayment.md)
* [DistributionWithDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionwithdetails.md)
* [DividendDistributionDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/dividenddistributiondetails.md)
* [DividendDistributionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/dividenddistributionparams.md)
* [EditClaimsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/editclaimsparams.md)
* [EventIdentifier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/eventidentifier.md)
* [ExtrinsicData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/extrinsicdata.md)
* [Fees](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/fees.md)
* [FeesBreakdown](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/feesbreakdown.md)
* [GroupedInstructions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/groupedinstructions.md)
* [HistoricAgentOperation](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/historicagentoperation.md)
* [HistoricSettlement](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/historicsettlement.md)
* [HumanReadable](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/humanreadable.md)
* [IdentityBalance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitybalance.md)
* [IdentityRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identityrole.md)
* [IdentityWithClaims](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitywithclaims.md)
* [InstructionAffirmation](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/instructionaffirmation.md)
* [InvestInStoParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/investinstoparams.md)
* [Investment](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/investment.md)
* [InviteAccountParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/inviteaccountparams.md)
* [InviteExternalAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/inviteexternalagentparams.md)
* [IssueTokensParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/issuetokensparams.md)
* [KeyringPair](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/keyringpair.md)
* [LeaveIdentityParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/leaveidentityparams.md)
* [Leg](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/leg.md)
* [LinkCaDocsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/linkcadocsparams.md)
* [MiddlewareConfig](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/middlewareconfig.md)
* [ModifyCorporateActionsAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/modifycorporateactionsagentparams.md)
* [ModifyInstructionAffirmationParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/modifyinstructionaffirmationparams.md)
* [ModifyPrimaryIssuanceAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/modifyprimaryissuanceagentparams.md)
* [ModifySignerPermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/modifysignerpermissionsparams.md)
* [ModifyTokenTrustedClaimIssuersAddSetParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/modifytokentrustedclaimissuersaddsetparams.md)
* [ModifyTokenTrustedClaimIssuersRemoveParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/modifytokentrustedclaimissuersremoveparams.md)
* [MoveFundsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/movefundsparams.md)
* [NetworkProperties](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/networkproperties.md)
* [PaginationOptions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/paginationoptions.md)
* [PayDividendsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/paydividendsparams.md)
* [PercentageTransferRestriction](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/percentagetransferrestriction.md)
* [PercentageTransferRestrictionInput](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/percentagetransferrestrictioninput.md)
* [PlainTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/plaintransactionargument.md)
* [PortfolioBalance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/portfoliobalance.md)
* [PortfolioCustodianRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/portfoliocustodianrole.md)
* [PortfolioMovement](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/portfoliomovement.md)
* [ProcedureAuthorizationStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureauthorizationstatus.md)
* [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md)
* [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)
* [ProposalDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proposaldetails.md)
* [ProposalTimeFrames](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proposaltimeframes.md)
* [ProposalVote](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proposalvote.md)
* [RedeemTokenParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/redeemtokenparams.md)
* [RegisterIdentityParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/registeridentityparams.md)
* [RemoveCheckpointScheduleParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/removecheckpointscheduleparams.md)
* [RemoveCorporateActionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/removecorporateactionparams.md)
* [RemoveExternalAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/removeexternalagentparams.md)
* [RemoveSecondaryKeysParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/removesecondarykeysparams.md)
* [RenamePortfolioParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/renameportfolioparams.md)
* [Requirement](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/requirement.md)
* [RequirementCompliance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/requirementcompliance.md)
* [ReserveTickerParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/reservetickerparams.md)
* [ResultSet](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)
* [RevokeClaimsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/revokeclaimsparams.md)
* [ScheduleDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/scheduledetails.md)
* [ScheduleWithDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/schedulewithdetails.md)
* [Scope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/scope.md)
* [SecondaryKey](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/secondarykey.md)
* [SectionPermissions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/sectionpermissions.md)
* [SecurityTokenDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/securitytokendetails.md)
* [SetAssetRequirementsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setassetrequirementsparams.md)
* [SetCountTransferRestrictionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setcounttransferrestrictionsparams.md)
* [SetCustodianParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setcustodianparams.md)
* [SetGroupPermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setgrouppermissionsparams.md)
* [SetPercentageTransferRestrictionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setpercentagetransferrestrictionsparams.md)
* [SetPermissionGroupParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setpermissiongroupparams.md)
* [SetTokenDocumentsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/settokendocumentsparams.md)
* [SettlementLeg](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/settlementleg.md)
* [SignerValue](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/signervalue.md)
* [SimpleEnumTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/simpleenumtransactionargument.md)
* [SimplePermissions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/simplepermissions.md)
* [StoDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stodetails.md)
* [StoStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stostatus.md)
* [StoTier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stotier.md)
* [StoWithDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/stowithdetails.md)
* [Subsidy](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/subsidy.md)
* [TaxWithholding](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/taxwithholding.md)
* [ThirdPartyFees](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/thirdpartyfees.md)
* [TickerOwnerRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tickerownerrole.md)
* [TickerReservationDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tickerreservationdetails.md)
* [Tier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tier.md)
* [ToggleFreezeSecondaryKeysParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/togglefreezesecondarykeysparams.md)
* [ToggleFreezeStoParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/togglefreezestoparams.md)
* [ToggleFreezeTransfersParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/togglefreezetransfersparams.md)
* [TogglePauseRequirementsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/togglepauserequirementsparams.md)
* [TokenBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tokenbase.md)
* [TokenDocument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tokendocument.md)
* [TokenIdentifier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tokenidentifier.md)
* [TokenWithGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tokenwithgroup.md)
* [TransactionPermissions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transactionpermissions.md)
* [TransactionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transactionsparams.md)
* [TransferBreakdown](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transferbreakdown.md)
* [TransferPolyxParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transferpolyxparams.md)
* [TransferRestriction](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transferrestriction.md)
* [TransferRestrictionInputBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transferrestrictioninputbase.md)
* [TransferRestrictionResult](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transferrestrictionresult.md)
* [TransferTickerOwnershipParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transfertickerownershipparams.md)
* [TransferTokenOwnershipParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/transfertokenownershipparams.md)
* [TrustedClaimIssuer](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/trustedclaimissuer.md)
* [TxGroupParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/txgroupparams.md)
* [UiKeyring](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/uikeyring.md)
* [UniqueIdentifiers](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/uniqueidentifiers.md)
* [VenueDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/venuedetails.md)
* [VenueOwnerRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/venueownerrole.md)
* [WaivePermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/waivepermissionsparams.md)

### Type aliases

* [AccountBalance](#accountbalance)
* [AddCountTransferRestrictionParams](#addcounttransferrestrictionparams)
* [AddPairParams](#addpairparams)
* [AddPercentageTransferRestrictionParams](#addpercentagetransferrestrictionparams)
* [AddRestrictionParams](#addrestrictionparams)
* [ArgsType](#argstype)
* [Authorization](#authorization)
* [CddClaim](#cddclaim)
* [CheckpointScheduleParams](#checkpointscheduleparams)
* [Claim](#claim)
* [CommonKeyring](#commonkeyring)
* [Condition](#condition)
* [ConditionBase](#conditionbase)
* [ConfigureDividendDistributionParams](#configuredividenddistributionparams)
* [Ensured](#ensured)
* [ExternalAgentCondition](#externalagentcondition)
* [GetReturnType](#getreturntype)
* [GroupPermissions](#grouppermissions)
* [HumanReadableType](#humanreadabletype)
* [IdentityCondition](#identitycondition)
* [InputTargets](#inputtargets)
* [InputTaxWithholding](#inputtaxwithholding)
* [InstructionDetails](#instructiondetails)
* [InstructionStatusResult](#instructionstatusresult)
* [InvestorUniquenessClaim](#investoruniquenessclaim)
* [InvestorUniquenessV2Claim](#investoruniquenessv2claim)
* [ModifyCaDefaultsParams](#modifycadefaultsparams)
* [ModifyClaimsParams](#modifyclaimsparams)
* [ModifyStoTimesParams](#modifystotimesparams)
* [ModifyTokenParams](#modifytokenparams)
* [ModifyVenueParams](#modifyvenueparams)
* [MultiClaimCondition](#multiclaimcondition)
* [Mutable](#mutable)
* [NextKey](#nextkey)
* [PermissionsLike](#permissionslike)
* [PortfolioLike](#portfoliolike)
* [ProcedureFunc](#procedurefunc)
* [QueryReturnType](#queryreturntype)
* [Role](#role)
* [ScopedClaim](#scopedclaim)
* [SetRestrictionsParams](#setrestrictionsparams)
* [SetTransferRestrictionsParams](#settransferrestrictionsparams)
* [Signer](#signer)
* [SingleClaimCondition](#singleclaimcondition)
* [SubCallback](#subcallback)
* [TransactionArgument](#transactionargument)
* [UnionOfProcedureFuncs](#unionofprocedurefuncs)
* [UnscopedClaim](#unscopedclaim)
* [UnsubCallback](#unsubcallback)

### Variables

* [executedMessage](#const-executedmessage)
* [notExistsMessage](#const-notexistsmessage)

### Functions

* [areSameClaimIssuers](#const-aresameclaimissuers)
* [areSameClaims](#const-aresameclaims)
* [areSameTargets](#const-aresametargets)
* [convertArgsToRaw](#const-convertargstoraw)
* [createProcedureMethod](#createproceduremethod)
* [findClaimsByOtherIssuers](#const-findclaimsbyotherissuers)
* [findPositiveBalanceIuClaims](#const-findpositivebalanceiuclaims)
* [tickerToDid](#tickertodid)
* [toHumanReadable](#tohumanreadable)
* [tuple](#const-tuple)
* [txGroupToTxTags](#txgrouptotxtags)

### Object literals

* [defaultMessages](#const-defaultmessages)

## Type aliases

### AccountBalance

Ƭ **AccountBalance**: [*Balance*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/balance.md)

*Defined in* [*src/types/index.ts:577*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L577)

***

### AddCountTransferRestrictionParams

Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/counttransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/addTransferRestriction.ts#L23)

***

### AddPairParams

Ƭ **AddPairParams**: *object*

*Defined in* [*src/base/Context.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/base/Context.ts#L91)

#### Type declaration:

* **accountMnemonic**? : *undefined | string*
* **accountSeed**? : *undefined | string*
* **accountUri**? : *undefined | string*
* **pair**? : [*KeyringPair*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/keyringpair.md)

***

### AddPercentageTransferRestrictionParams

Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/percentagetransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:27*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/addTransferRestriction.ts#L27)

***

### AddRestrictionParams

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

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:32*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L32)

***

### ArgsType

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

*Defined in* [*src/types/utils/index.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/utils/index.ts#L24)

Less strict version of Parameters

***

### Authorization

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

*Defined in* [*src/types/index.ts:864*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L864)

Authorization request data corresponding to type

***

### CddClaim

Ƭ **CddClaim**: *object*

*Defined in* [*src/types/index.ts:255*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L255)

#### Type declaration:

* **id**: *string*
* **type**: [*CustomerDueDiligence*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/claimtype.md#customerduediligence)

***

### CheckpointScheduleParams

Ƭ **CheckpointScheduleParams**: *Omit‹UniqueIdentifiers & Params, "ticker"›*

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

***

### Claim

Ƭ **Claim**: [*ScopedClaim*](#scopedclaim) *|* [*UnscopedClaim*](#unscopedclaim)

*Defined in* [*src/types/index.ts:286*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L286)

***

### CommonKeyring

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

*Defined in* [*src/types/index.ts:546*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L546)

***

### Condition

Ƭ **Condition**: [*SingleClaimCondition*](#singleclaimcondition) *|* [*MultiClaimCondition*](#multiclaimcondition) *|* [*IdentityCondition*](#identitycondition) *|* [*ExternalAgentCondition*](#externalagentcondition)

*Defined in* [*src/types/index.ts:376*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L376)

***

### ConditionBase

Ƭ **ConditionBase**: *object*

*Defined in* [*src/types/index.ts:355*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L355)

#### Type declaration:

* **target**: [*ConditionTarget*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/conditiontarget.md)
* **trustedClaimIssuers**? : [*TrustedClaimIssuer*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/trustedclaimissuer.md)*\[]*

***

### ConfigureDividendDistributionParams

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

*Defined in* [*src/api/procedures/configureDividendDistribution.ts:62*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/configureDividendDistribution.ts#L62)

***

### Ensured

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

*Defined in* [*src/types/index.ts:539*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L539)

***

### ExternalAgentCondition

Ƭ **ExternalAgentCondition**: [*ConditionBase*](#conditionbase) *& object*

*Defined in* [*src/types/index.ts:372*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L372)

***

### GetReturnType

Ƭ **GetReturnType**: [*ActiveTransferRestrictions*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/activetransferrestrictions.md)*‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L46)

***

### GroupPermissions

Ƭ **GroupPermissions**: *Pick‹Permissions, "transactions" | "transactionGroups"›*

*Defined in* [*src/types/index.ts:799*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L799)

Security Token permissions shared by agents in a group

***

### HumanReadableType

Ƭ **HumanReadableType**: *T extends Entity‹unknown, infer H› ? HumanReadableType‹H› : T extends BigNumber ? string : T extends Date ? string : T extends object ? object : T*

*Defined in* [*src/types/utils/index.ts:30*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/utils/index.ts#L30)

Recursively traverse a type and transform its Entity properties into their human readable version (as if `.toJson` had been called on all of them)

***

### IdentityCondition

Ƭ **IdentityCondition**: [*ConditionBase*](#conditionbase) *& object*

*Defined in* [*src/types/index.ts:367*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L367)

***

### InputTargets

Ƭ **InputTargets**: *Omit‹*[*CorporateActionTargets*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/corporateactiontargets.md)*, "identities"› & object*

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

***

### InputTaxWithholding

Ƭ **InputTaxWithholding**: *Omit‹*[*TaxWithholding*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/taxwithholding.md)*, "identity"› & object*

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

***

### InstructionDetails

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

*Defined in* [*src/api/entities/Instruction/types.ts:17*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Instruction/types.ts#L17)

***

### InstructionStatusResult

Ƭ **InstructionStatusResult**: *object | object*

*Defined in* [*src/api/entities/Instruction/types.ts:57*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Instruction/types.ts#L57)

***

### InvestorUniquenessClaim

Ƭ **InvestorUniquenessClaim**: *object*

*Defined in* [*src/types/index.ts:257*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L257)

#### Type declaration:

* **cddId**: *string*
* **scope**: [*Scope*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/scope.md)
* **scopeId**: *string*
* **type**: [*InvestorUniqueness*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/claimtype.md#investoruniqueness)

***

### InvestorUniquenessV2Claim

Ƭ **InvestorUniquenessV2Claim**: *object*

*Defined in* [*src/types/index.ts:264*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L264)

#### Type declaration:

* **cddId**: *string*
* **type**: [*InvestorUniquenessV2*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/claimtype.md#investoruniquenessv2)

***

### ModifyCaDefaultsParams

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

*Defined in* [*src/api/procedures/modifyCaDefaults.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/modifyCaDefaults.ts#L23)

***

### ModifyClaimsParams

Ƭ **ModifyClaimsParams**: [*AddClaimsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addclaimsparams.md) *|* [*EditClaimsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/editclaimsparams.md) *|* [*RevokeClaimsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/revokeclaimsparams.md)

*Defined in* [*src/api/procedures/modifyClaims.ts:63*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/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/da0f7fd7/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/da0f7fd7/src/api/procedures/modifyToken.ts#L13)

***

### ModifyVenueParams

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

*Defined in* [*src/api/procedures/modifyVenue.ts:8*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/modifyVenue.ts#L8)

***

### MultiClaimCondition

Ƭ **MultiClaimCondition**: [*ConditionBase*](#conditionbase) *& object*

*Defined in* [*src/types/index.ts:362*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L362)

***

### Mutable

Ƭ **Mutable**: *object*

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

#### Type declaration:

***

### NextKey

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

*Defined in* [*src/types/index.ts:584*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L584)

***

### PermissionsLike

Ƭ **PermissionsLike**: *object & object | object*

*Defined in* [*src/types/index.ts:979*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L979)

Permissions to grant to a Signer over an Identity

**`link`** [Permissions](/polymesh-sdk-api-reference/v11.0.2/classes/permissions.md)

**`note`** TxGroups in the `transactionGroups` array will be transformed into their corresponding `TxTag`s

***

### PortfolioLike

Ƭ **PortfolioLike**: *string |* [*Identity*](/polymesh-sdk-api-reference/v11.0.2/classes/identity.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/v11.0.2/classes/numberedportfolio.md) *|* [*DefaultPortfolio*](/polymesh-sdk-api-reference/v11.0.2/classes/defaultportfolio.md) *| object*

*Defined in* [*src/types/index.ts:965*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L965)

***

### ProcedureFunc

Ƭ **ProcedureFunc**: *function*

*Defined in* [*src/types/utils/index.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/utils/index.ts#L11)

#### Type declaration:

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

***

### QueryReturnType

Ƭ **QueryReturnType**: *T extends AugmentedQuery‹"promise", infer Fun› ? ReturnType‹Fun› extends Observable‹infer R› ? R : never : never*

*Defined in* [*src/types/utils/index.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/utils/index.ts#L50)

Extract the return type of a polkadot.js query function

**`example`** `QueryReturnType<typeof identity.authorizations>` returns `Option<Authorization>`

***

### Role

Ƭ **Role**: [*TickerOwnerRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/tickerownerrole.md) *|* [*CddProviderRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/cddproviderrole.md) *|* [*VenueOwnerRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/venueownerrole.md) *|* [*PortfolioCustodianRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/portfoliocustodianrole.md) *|* [*IdentityRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identityrole.md)

*Defined in* [*src/types/index.ts:120*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L120)

***

### ScopedClaim

Ƭ **ScopedClaim**: *object |* [*InvestorUniquenessClaim*](#investoruniquenessclaim) *| object*

*Defined in* [*src/types/index.ts:269*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L269)

***

### SetRestrictionsParams

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

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:39*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L39)

***

### SetTransferRestrictionsParams

Ƭ **SetTransferRestrictionsParams**: *object &* [*SetCountTransferRestrictionsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setcounttransferrestrictionsparams.md) *|* [*SetPercentageTransferRestrictionsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/setpercentagetransferrestrictionsparams.md)

*Defined in* [*src/api/procedures/setTransferRestrictions.ts:39*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/setTransferRestrictions.ts#L39)

***

### Signer

Ƭ **Signer**: [*Identity*](/polymesh-sdk-api-reference/v11.0.2/classes/identity.md) *|* [*Account*](/polymesh-sdk-api-reference/v11.0.2/classes/account.md)

*Defined in* [*src/types/index.ts:941*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L941)

***

### SingleClaimCondition

Ƭ **SingleClaimCondition**: [*ConditionBase*](#conditionbase) *& object*

*Defined in* [*src/types/index.ts:357*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L357)

***

### SubCallback

Ƭ **SubCallback**: *function*

*Defined in* [*src/types/index.ts:535*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L535)

#### Type declaration:

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

**Parameters:**

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

***

### TransactionArgument

Ƭ **TransactionArgument**: *object &* [*PlainTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/plaintransactionargument.md) *|* [*ArrayTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/arraytransactionargument.md) *|* [*SimpleEnumTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/simpleenumtransactionargument.md) *|* [*ComplexTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/complextransactionargument.md)

*Defined in* [*src/types/index.ts:930*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L930)

***

### UnionOfProcedureFuncs

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

*Defined in* [*src/types/utils/index.ts:17*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/utils/index.ts#L17)

***

### UnscopedClaim

Ƭ **UnscopedClaim**: *object |* [*CddClaim*](#cddclaim) *|* [*InvestorUniquenessV2Claim*](#investoruniquenessv2claim)

*Defined in* [*src/types/index.ts:284*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L284)

***

### UnsubCallback

Ƭ **UnsubCallback**: *function*

*Defined in* [*src/types/index.ts:537*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/index.ts#L537)

#### Type declaration:

▸ (): *void*

## Variables

### `Const` executedMessage

• **executedMessage**: *"Instruction has already been executed/rejected and it was purged from chain"* = "Instruction has already been executed/rejected and it was purged from chain"

*Defined in* [*src/api/entities/Instruction/index.ts:57*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Instruction/index.ts#L57)

***

### `Const` notExistsMessage

• **notExistsMessage**: *"The Dividend Distribution no longer exists"* = "The Dividend Distribution no longer exists"

*Defined in* [*src/api/entities/Portfolio/index.ts:51*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Portfolio/index.ts#L51)

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/CheckpointSchedule/index.ts#L36)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L81)

## Functions

### `Const` areSameClaimIssuers

▸ **areSameClaimIssuers**(`currentClaimIssuers`: [TrustedClaimIssuer](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/trustedclaimissuer.md)\[], `claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]): *boolean*

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

**Parameters:**

| Name                  | Type                                                                                                                         |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `currentClaimIssuers` | [TrustedClaimIssuer](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/trustedclaimissuer.md)\[] |
| `claimIssuers`        | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]                                                                  |

**Returns:** *boolean*

***

### `Const` areSameClaims

▸ **areSameClaims**(`claim`: [Claim](#claim), `__namedParameters`: object): *boolean*

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

**Parameters:**

▪ **claim**: [*Claim*](#claim)

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

| Name    | Type                                                                                                                 |
| ------- | -------------------------------------------------------------------------------------------------------------------- |
| `scope` | undefined \| null \| [Scope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/scope.md) |
| `type`  | ClaimTypeEnum                                                                                                        |

**Returns:** *boolean*

***

### `Const` areSameTargets

▸ **areSameTargets**(`targets`: [CorporateActionTargets](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/corporateactiontargets.md), `newTargets`: [InputTargets](#inputtargets)): *boolean*

*Defined in* [*src/api/procedures/modifyCaDefaults.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/procedures/modifyCaDefaults.ts#L45)

**Parameters:**

| Name         | Type                                                                                                                              |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------- |
| `targets`    | [CorporateActionTargets](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/corporateactiontargets.md) |
| `newTargets` | [InputTargets](#inputtargets)                                                                                                     |

**Returns:** *boolean*

***

### `Const` convertArgsToRaw

▸ **convertArgsToRaw**(`claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"], `rawTicker`: Ticker, `context`: [Context](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)): *object*

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

**Parameters:**

| Name           | Type                                                              |
| -------------- | ----------------------------------------------------------------- |
| `claimIssuers` | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]       |
| `rawTicker`    | Ticker                                                            |
| `context`      | [Context](/polymesh-sdk-api-reference/v11.0.2/classes/context.md) |

**Returns:** *object*

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

***

### createProcedureMethod

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **Storage**›(`args`: object, `context`: [Context](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)): [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›*

*Defined in* [*src/utils/internal.ts:411*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/utils/internal.ts#L411)

Create a method that prepares a procedure

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

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

▪ **context**: [*Context*](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)

**Returns:** [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›*

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **ReturnValue**, **Storage**›(`args`: object, `context`: [Context](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)): [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ReturnValue›*

*Defined in* [*src/utils/internal.ts:430*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/utils/internal.ts#L430)

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **ReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

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

▪ **context**: [*Context*](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)

**Returns:** [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ReturnValue›*

***

### `Const` findClaimsByOtherIssuers

▸ **findClaimsByOtherIssuers**(`claims`: [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimtarget.md)\[], `claimsByDid`: Record‹string, MiddlewareClaim\[]›): [*Claim*](#claim)*\[]*

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

**Parameters:**

| Name          | Type                                                                                                           |
| ------------- | -------------------------------------------------------------------------------------------------------------- |
| `claims`      | [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimtarget.md)\[] |
| `claimsByDid` | Record‹string, MiddlewareClaim\[]›                                                                             |

**Returns:** [*Claim*](#claim)*\[]*

***

### `Const` findPositiveBalanceIuClaims

▸ **findPositiveBalanceIuClaims**(`claims`: [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimtarget.md)\[], `context`: [Context](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)): *Promise‹*[*Claim*](#claim)*\[]›*

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

**Parameters:**

| Name      | Type                                                                                                           |
| --------- | -------------------------------------------------------------------------------------------------------------- |
| `claims`  | [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimtarget.md)\[] |
| `context` | [Context](/polymesh-sdk-api-reference/v11.0.2/classes/context.md)                                              |

**Returns:** *Promise‹*[*Claim*](#claim)*\[]›*

***

### tickerToDid

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

*Defined in* [*src/utils/conversion.ts:230*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/utils/conversion.ts#L230)

Generate a Security Token's DID from a ticker

**Parameters:**

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

**Returns:** *string*

***

### toHumanReadable

▸ **toHumanReadable**‹**T**›(`obj`: T): [*HumanReadableType*](#humanreadabletype)*‹T›*

*Defined in* [*src/utils/internal.ts:689*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/utils/internal.ts#L689)

Recursively convert a value into a human readable (JSON compliant) version:

* Entities are converted via their `.toJson` method
* Dates are converted to ISO strings
* BigNumbers are converted to numerical strings

**Type parameters:**

▪ **T**

**Parameters:**

| Name  | Type |
| ----- | ---- |
| `obj` | T    |

**Returns:** [*HumanReadableType*](#humanreadabletype)*‹T›*

***

### `Const` tuple

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

*Defined in* [*src/types/utils/index.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/types/utils/index.ts#L61)

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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/txgroup.md)): *TxTag\[]*

*Defined in* [*src/utils/conversion.ts:595*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/utils/conversion.ts#L595)

Retrieve every Transaction Tag associated to a Transaction Group

**Parameters:**

| Name    | Type                                                                                           |
| ------- | ---------------------------------------------------------------------------------------------- |
| `group` | [TxGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/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/da0f7fd7/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/da0f7fd7/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/da0f7fd7/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/da0f7fd7/src/base/PolymeshError.ts#L6)