# Globals

## Index

### Enumerations

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

### Classes

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

### Interfaces

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

### Type aliases

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

### Variables

* [executedMessage](/polymesh-sdk-api-reference/docs-v8/globals.md#const-executedmessage)
* [notExistsMessage](/polymesh-sdk-api-reference/docs-v8/globals.md#const-notexistsmessage)

### Functions

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

### Object literals

* [defaultMessages](/polymesh-sdk-api-reference/docs-v8/globals.md#const-defaultmessages)

## Type aliases

### AccountBalance

Ƭ **AccountBalance**: [*Balance*](/polymesh-sdk-api-reference/docs-v8/interfaces/balance.md)

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

### AddCountTransferRestrictionParams

Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](/polymesh-sdk-api-reference/docs-v8/interfaces/counttransferrestrictioninput.md) *& object*

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

### AddPairParams

Ƭ **AddPairParams**: *object*

*Defined in* [*src/base/Context.ts:94*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/base/Context.ts#L94)

#### Type declaration:

* **accountMnemonic**? : *undefined | string*
* **accountSeed**? : *undefined | string*
* **accountUri**? : *undefined | string*
* **pair**? : [*KeyringPair*](/polymesh-sdk-api-reference/docs-v8/interfaces/keyringpair.md)

### AddPercentageTransferRestrictionParams

Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](/polymesh-sdk-api-reference/docs-v8/interfaces/percentagetransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:28*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/procedures/addTransferRestriction.ts#L28)

### 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/7362b318/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L32)

### ArgsType

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

*Defined in* [*src/types/utils/index.ts:22*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/utils/index.ts#L22)

Less strict version of Parameters

### Authorization

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

*Defined in* [*src/types/index.ts:783*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L783)

Authorization request data corresponding to type

### CddClaim

Ƭ **CddClaim**: *object*

*Defined in* [*src/types/index.ts:241*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L241)

#### Type declaration:

* **id**: *string*
* **type**: [*CustomerDueDiligence*](/polymesh-sdk-api-reference/docs-v8/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/7362b318/src/api/entities/CheckpointSchedule/types.ts#L8)

### Claim

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

*Defined in* [*src/types/index.ts:272*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L272)

### CommonKeyring

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

*Defined in* [*src/types/index.ts:532*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L532)

### Condition

Ƭ **Condition**: [*SingleClaimCondition*](/polymesh-sdk-api-reference/docs-v8/globals.md#singleclaimcondition) *|* [*MultiClaimCondition*](/polymesh-sdk-api-reference/docs-v8/globals.md#multiclaimcondition) *|* [*IdentityCondition*](/polymesh-sdk-api-reference/docs-v8/globals.md#identitycondition) *|* [*ExternalAgentCondition*](/polymesh-sdk-api-reference/docs-v8/globals.md#externalagentcondition)

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

### ConditionBase

Ƭ **ConditionBase**: *object*

*Defined in* [*src/types/index.ts:341*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L341)

#### Type declaration:

* **target**: [*ConditionTarget*](/polymesh-sdk-api-reference/docs-v8/enums/conditiontarget.md)
* **trustedClaimIssuers**? : [*TrustedClaimIssuer*](/polymesh-sdk-api-reference/docs-v8/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/7362b318/src/api/procedures/configureDividendDistribution.ts#L59)

### Ensured

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

*Defined in* [*src/types/index.ts:525*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L525)

### ExternalAgentCondition

Ƭ **ExternalAgentCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v8/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:358*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L358)

### GetReturnType

Ƭ **GetReturnType**: [*ActiveTransferRestrictions*](/polymesh-sdk-api-reference/docs-v8/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/7362b318/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L46)

### GroupPermissions

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

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

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:28*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/utils/index.ts#L28)

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*](/polymesh-sdk-api-reference/docs-v8/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:353*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L353)

### InputTargets

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

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

### InputTaxWithholding

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

*Defined in* [*src/api/entities/CorporateAction/types.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/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/7362b318/src/api/entities/Instruction/types.ts#L17)

### InstructionStatusResult

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

*Defined in* [*src/api/entities/Instruction/types.ts:58*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Instruction/types.ts#L58)

### InvestorUniquenessClaim

Ƭ **InvestorUniquenessClaim**: *object*

*Defined in* [*src/types/index.ts:243*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L243)

#### Type declaration:

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

### InvestorUniquenessV2Claim

Ƭ **InvestorUniquenessV2Claim**: *object*

*Defined in* [*src/types/index.ts:250*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L250)

#### Type declaration:

* **cddId**: *string*
* **type**: [*InvestorUniquenessV2*](/polymesh-sdk-api-reference/docs-v8/enums/claimtype.md#investoruniquenessv2)

### ModifyCaDefaultsParams

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

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

### ModifyClaimsParams

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

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

### MultiClaimCondition

Ƭ **MultiClaimCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v8/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:348*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L348)

### Mutable

Ƭ **Mutable**: *object*

*Defined in* [*src/types/utils/index.ts:5*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/utils/index.ts#L5)

#### Type declaration:

### NextKey

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

*Defined in* [*src/types/index.ts:570*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L570)

### PermissionsLike

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

*Defined in* [*src/types/index.ts:896*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L896)

Permissions to grant to a Signer over an Identity

**`link`** [Permissions](/polymesh-sdk-api-reference/docs-v8/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/docs-v8/classes/identity.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md) *|* [*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v8/classes/defaultportfolio.md) *| object*

*Defined in* [*src/types/index.ts:882*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L882)

### ProcedureFunc

Ƭ **ProcedureFunc**: *function*

*Defined in* [*src/types/utils/index.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/utils/index.ts#L9)

#### Type declaration:

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

### Role

Ƭ **Role**: [*TickerOwnerRole*](/polymesh-sdk-api-reference/docs-v8/interfaces/tickerownerrole.md) *|* [*CddProviderRole*](/polymesh-sdk-api-reference/docs-v8/interfaces/cddproviderrole.md) *|* [*VenueOwnerRole*](/polymesh-sdk-api-reference/docs-v8/interfaces/venueownerrole.md) *|* [*PortfolioCustodianRole*](/polymesh-sdk-api-reference/docs-v8/interfaces/portfoliocustodianrole.md)

*Defined in* [*src/types/index.ts:113*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L113)

### ScopedClaim

Ƭ **ScopedClaim**: *object |* [*InvestorUniquenessClaim*](/polymesh-sdk-api-reference/docs-v8/globals.md#investoruniquenessclaim) *| object*

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

### 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/7362b318/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L39)

### SetTransferRestrictionsParams

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

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

### Signer

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

*Defined in* [*src/types/index.ts:858*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L858)

### SingleClaimCondition

Ƭ **SingleClaimCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v8/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:343*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L343)

### SubCallback

Ƭ **SubCallback**: *function*

*Defined in* [*src/types/index.ts:521*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L521)

#### Type declaration:

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

**Parameters:**

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

### TokenType

Ƭ **TokenType**: [*KnownTokenType*](/polymesh-sdk-api-reference/docs-v8/enums/knowntokentype.md) *| object*

*Defined in* [*src/types/index.ts:159*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L159)

Type of security that the token represents

### TransactionArgument

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

*Defined in* [*src/types/index.ts:847*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L847)

### UnionOfProcedureFuncs

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

*Defined in* [*src/types/utils/index.ts:15*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/utils/index.ts#L15)

### UnscopedClaim

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

*Defined in* [*src/types/index.ts:270*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L270)

### UnsubCallback

Ƭ **UnsubCallback**: *function*

*Defined in* [*src/types/index.ts:523*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/index.ts#L523)

#### 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/7362b318/src/api/entities/Instruction/index.ts#L57)

### `Const` notExistsMessage

• **notExistsMessage**: *"Schedule no longer exists. It was either removed or it expired"* = "Schedule no longer exists. It was either removed or it expired"

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

## Functions

### `Const` areSameClaimIssuers

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

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

**Parameters:**

| Name                  | Type                                                                                          |
| --------------------- | --------------------------------------------------------------------------------------------- |
| `currentClaimIssuers` | [TrustedClaimIssuer](/polymesh-sdk-api-reference/docs-v8/interfaces/trustedclaimissuer.md)\[] |
| `claimIssuers`        | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]                                   |

**Returns:** *boolean*

### `Const` areSameClaims

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

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

**Parameters:**

▪ **claim**: [*Claim*](/polymesh-sdk-api-reference/docs-v8/globals.md#claim)

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

| Name    | Type                                                                                  |
| ------- | ------------------------------------------------------------------------------------- |
| `scope` | undefined \| null \| [Scope](/polymesh-sdk-api-reference/docs-v8/interfaces/scope.md) |
| `type`  | ClaimTypeEnum                                                                         |

**Returns:** *boolean*

### `Const` areSameTargets

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

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

**Parameters:**

| Name         | Type                                                                                               |
| ------------ | -------------------------------------------------------------------------------------------------- |
| `targets`    | [CorporateActionTargets](/polymesh-sdk-api-reference/docs-v8/interfaces/corporateactiontargets.md) |
| `newTargets` | [InputTargets](/polymesh-sdk-api-reference/docs-v8/globals.md#inputtargets)                        |

**Returns:** *boolean*

### `Const` convertArgsToRaw

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

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

**Parameters:**

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

**Returns:** *object*

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

### createProcedureMethod

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

*Defined in* [*src/utils/internal.ts:403*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/utils/internal.ts#L403)

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/docs-v8/classes/context.md)

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

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

*Defined in* [*src/utils/internal.ts:422*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/utils/internal.ts#L422)

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **ReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

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

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

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

### `Const` findClaimsByOtherIssuers

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

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

**Parameters:**

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

**Returns:** [*Claim*](/polymesh-sdk-api-reference/docs-v8/globals.md#claim)*\[]*

### `Const` findPositiveBalanceIuClaims

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

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

**Parameters:**

| Name      | Type                                                                            |
| --------- | ------------------------------------------------------------------------------- |
| `claims`  | [ClaimTarget](/polymesh-sdk-api-reference/docs-v8/interfaces/claimtarget.md)\[] |
| `context` | [Context](/polymesh-sdk-api-reference/docs-v8/classes/context.md)               |

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

### tickerToDid

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

*Defined in* [*src/utils/conversion.ts:227*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/utils/conversion.ts#L227)

Generate a Security Token's DID from a ticker

**Parameters:**

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

**Returns:** *string*

### toHumanReadable

▸ **toHumanReadable**‹**T**›(`obj`: T): [*HumanReadableType*](/polymesh-sdk-api-reference/docs-v8/globals.md#humanreadabletype)*‹T›*

*Defined in* [*src/utils/internal.ts:674*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/utils/internal.ts#L674)

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*](/polymesh-sdk-api-reference/docs-v8/globals.md#humanreadabletype)*‹T›*

### `Const` tuple

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

*Defined in* [*src/types/utils/index.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/types/utils/index.ts#L48)

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](/polymesh-sdk-api-reference/docs-v8/enums/txgroup.md)): *TxTag\[]*

*Defined in* [*src/utils/conversion.ts:592*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/utils/conversion.ts#L592)

Retrieve every Transaction Tag associated to a Transaction Group

**Parameters:**

| Name    | Type                                                            |
| ------- | --------------------------------------------------------------- |
| `group` | [TxGroup](/polymesh-sdk-api-reference/docs-v8/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/7362b318/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/7362b318/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/7362b318/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/7362b318/src/base/PolymeshError.ts#L6)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/globals.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.