# Globals

## Index

### Enumerations

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

### Classes

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

### Interfaces

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

### Type aliases

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

### Variables

* [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)
* [tuple](#const-tuple)
* [txGroupToTxTags](#txgrouptotxtags)

### Object literals

* [ErrorMessagesPerCode](#const-errormessagespercode)

## Type aliases

### AccountBalance

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

*Defined in* [*src/types/index.ts:615*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L615)

### AddCountTransferRestrictionParams

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

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

### AddPercentageTransferRestrictionParams

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

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

### AddRestrictionParams

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

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:30*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L30)

### Authorization

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

*Defined in* [*src/types/index.ts:252*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L252)

Authorization request data corresponding to type

### CddClaim

Ƭ **CddClaim**: *object*

*Defined in* [*src/types/index.ts:299*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L299)

#### Type declaration:

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

### CheckpointScheduleParams

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

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

### Claim

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

*Defined in* [*src/types/index.ts:330*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L330)

### CommonKeyring

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

*Defined in* [*src/types/index.ts:590*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L590)

### Condition

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

*Defined in* [*src/types/index.ts:420*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L420)

### ConditionBase

Ƭ **ConditionBase**: *object*

*Defined in* [*src/types/index.ts:399*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L399)

#### Type declaration:

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

### ConfigureDividendDistributionParams

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

*Defined in* [*src/api/procedures/configureDividendDistribution.ts:58*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/configureDividendDistribution.ts#L58)

### Ensured

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

*Defined in* [*src/types/index.ts:583*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L583)

### GetReturnType

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

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:44*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L44)

### IdentityCondition

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

*Defined in* [*src/types/index.ts:411*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L411)

### InputTargets

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

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

### InputTaxWithholding

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

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

### InstructionDetails

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

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

### InvestorUniquenessClaim

Ƭ **InvestorUniquenessClaim**: *object*

*Defined in* [*src/types/index.ts:301*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L301)

#### Type declaration:

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

### InvestorUniquenessV2Claim

Ƭ **InvestorUniquenessV2Claim**: *object*

*Defined in* [*src/types/index.ts:308*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L308)

#### Type declaration:

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

### ModifyCaDefaultsParams

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

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

### ModifyClaimsParams

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

*Defined in* [*src/api/procedures/modifyClaims.ts:54*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/modifyClaims.ts#L54)

### ModifyStoTimesParams

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

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

### MultiClaimCondition

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

*Defined in* [*src/types/index.ts:406*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L406)

### Mutable

Ƭ **Mutable**: *object*

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

#### Type declaration:

### NextKey

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

*Defined in* [*src/types/index.ts:622*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L622)

### PortfolioLike

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

*Defined in* [*src/types/index.ts:840*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L840)

### PrimaryIssuanceAgentCondition

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

*Defined in* [*src/types/index.ts:416*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L416)

### ProcedureFunc

Ƭ **ProcedureFunc**: *function*

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

#### Type declaration:

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

### Role

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

*Defined in* [*src/types/index.ts:176*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L176)

### ScopedClaim

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

*Defined in* [*src/types/index.ts:313*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L313)

### SetRestrictionsParams

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

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:37*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L37)

### SetTransferRestrictionsParams

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

*Defined in* [*src/api/procedures/setTransferRestrictions.ts:34*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/setTransferRestrictions.ts#L34)

### Signer

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

*Defined in* [*src/types/index.ts:721*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L721)

### SingleClaimCondition

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

*Defined in* [*src/types/index.ts:401*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L401)

### SubCallback

Ƭ **SubCallback**: *function*

*Defined in* [*src/types/index.ts:579*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L579)

#### Type declaration:

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

**Parameters:**

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

### TokenType

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

*Defined in* [*src/types/index.ts:201*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L201)

Type of security that the token represents

### TransactionArgument

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

*Defined in* [*src/types/index.ts:710*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L710)

### UnionOfProcedureFuncs

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

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

### UnscopedClaim

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

*Defined in* [*src/types/index.ts:328*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L328)

### UnsubCallback

Ƭ **UnsubCallback**: *function*

*Defined in* [*src/types/index.ts:581*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/types/index.ts#L581)

#### Type declaration:

▸ (): *void*

## Variables

### `Const` notExistsMessage

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

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

*Defined in* [*src/api/entities/Instruction/index.ts:40*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Instruction/index.ts#L40)

## Functions

### `Const` areSameClaimIssuers

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

*Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L65)

**Parameters:**

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

**Returns:** *boolean*

### `Const` areSameClaims

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

*Defined in* [*src/api/procedures/modifyClaims.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/modifyClaims.ts#L65)

**Parameters:**

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

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

| Name    | Type                                                                                                        |
| ------- | ----------------------------------------------------------------------------------------------------------- |
| `scope` | Falsyable‹[Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/scope)› |
| `type`  | ClaimTypeEnum                                                                                               |

**Returns:** *boolean*

### `Const` areSameTargets

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

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

**Parameters:**

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

**Returns:** *boolean*

### `Const` convertArgsToRaw

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

*Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L36)

**Parameters:**

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

**Returns:** *object*

* **claimIssuersToAdd**: *\[Ticker, TrustedIssuer]\[]*
* **inputDids**: *string\[]*

### createProcedureMethod

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

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

Create a method that prepares a procedure

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

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

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

**Returns:** *ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›*

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

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

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ProcedureReturnValue**

▪ **ReturnValue**

▪ **Storage**

**Parameters:**

▪ **args**: *object*

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

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

**Returns:** *ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›*

### `Const` findClaimsByOtherIssuers

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

*Defined in* [*src/api/procedures/modifyClaims.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/modifyClaims.ts#L75)

**Parameters:**

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

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

### `Const` findPositiveBalanceIuClaims

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

*Defined in* [*src/api/procedures/modifyClaims.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/procedures/modifyClaims.ts#L91)

**Parameters:**

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

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

### tickerToDid

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

*Defined in* [*src/utils/conversion.ts:213*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/utils/conversion.ts#L213)

Generate a Security Token's DID from a ticker

**Parameters:**

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

**Returns:** *string*

### `Const` tuple

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

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

Create a literal tuple type from a list of arguments

**Type parameters:**

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

**Parameters:**

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

**Returns:** *T*

### txGroupToTxTags

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

*Defined in* [*src/utils/conversion.ts:568*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/utils/conversion.ts#L568)

Retrieve every Transaction Tag associated to a Transaction Group

**Parameters:**

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

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

## Object literals

### `Const` ErrorMessagesPerCode

### ▪ **ErrorMessagesPerCode**: *object*

*Defined in* [*src/base/PolymeshError.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/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/524b0225/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/524b0225/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/524b0225/src/base/PolymeshError.ts#L6)