# Globals

## Index

### Enumerations

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

### Classes

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

### Interfaces

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

### Type aliases

* [AccountBalance](#accountbalance)
* [AddCountTransferRestrictionParams](#addcounttransferrestrictionparams)
* [AddPairParams](#addpairparams)
* [AddPercentageTransferRestrictionParams](#addpercentagetransferrestrictionparams)
* [AddRestrictionParams](#addrestrictionparams)
* [ArgsType](#argstype)
* [Authorization](#authorization)
* [CddClaim](#cddclaim)
* [CheckpointScheduleParams](#checkpointscheduleparams)
* [Claim](#claim)
* [CommonKeyring](#commonkeyring)
* [Condition](#condition)
* [ConditionBase](#conditionbase)
* [ConfigureDividendDistributionParams](#configuredividenddistributionparams)
* [Ensured](#ensured)
* [ExternalAgentCondition](#externalagentcondition)
* [GetReturnType](#getreturntype)
* [GroupPermissions](#grouppermissions)
* [HumanReadableType](#humanreadabletype)
* [IdentityCondition](#identitycondition)
* [InputTargets](#inputtargets)
* [InputTaxWithholding](#inputtaxwithholding)
* [InstructionDetails](#instructiondetails)
* [InstructionStatusResult](#instructionstatusresult)
* [InvestorUniquenessClaim](#investoruniquenessclaim)
* [InvestorUniquenessV2Claim](#investoruniquenessv2claim)
* [ModifyCaDefaultsParams](#modifycadefaultsparams)
* [ModifyClaimsParams](#modifyclaimsparams)
* [ModifyStoTimesParams](#modifystotimesparams)
* [ModifyTokenParams](#modifytokenparams)
* [ModifyVenueParams](#modifyvenueparams)
* [MultiClaimCondition](#multiclaimcondition)
* [Mutable](#mutable)
* [NextKey](#nextkey)
* [PermissionsLike](#permissionslike)
* [PortfolioLike](#portfoliolike)
* [ProcedureFunc](#procedurefunc)
* [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

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

### Functions

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

### Object literals

* [defaultMessages](#const-defaultmessages)

## Type aliases

### AccountBalance

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

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

### AddCountTransferRestrictionParams

Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/counttransferrestrictioninput) *& 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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/keyringpair)

### AddPercentageTransferRestrictionParams

Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/percentagetransferrestrictioninput) *& 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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/claimtype#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*](#scopedclaim) *|* [*UnscopedClaim*](#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*](#singleclaimcondition) *|* [*MultiClaimCondition*](#multiclaimcondition) *|* [*IdentityCondition*](#identitycondition) *|* [*ExternalAgentCondition*](#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/conditiontarget)
* **trustedClaimIssuers**? : [*TrustedClaimIssuer*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/trustedclaimissuer)*\[]*

### 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*](#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/activetransferrestrictions)*‹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*](#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/corporateactiontargets)*, "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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/taxwithholding)*, "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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/scope)
* **scopeId**: *string*
* **type**: [*InvestorUniqueness*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/claimtype#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/claimtype#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/addclaimsparams) *|* [*EditClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/editclaimsparams) *|* [*RevokeClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/revokeclaimsparams)

*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*](#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/permissions)

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

### PortfolioLike

Ƭ **PortfolioLike**: *string |* [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/identity) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio) *|* [*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/defaultportfolio) *| 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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/tickerownerrole) *|* [*CddProviderRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/cddproviderrole) *|* [*VenueOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/venueownerrole) *|* [*PortfolioCustodianRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/portfoliocustodianrole)

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

### ScopedClaim

Ƭ **ScopedClaim**: *object |* [*InvestorUniquenessClaim*](#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/setcounttransferrestrictionsparams) *|* [*SetPercentageTransferRestrictionsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/setpercentagetransferrestrictionsparams)

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/identity) *|* [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/account)

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

### SingleClaimCondition

Ƭ **SingleClaimCondition**: [*ConditionBase*](#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/knowntokentype) *| 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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/plaintransactionargument) *|* [*ArrayTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/arraytransactionargument) *|* [*SimpleEnumTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/simpleenumtransactionargument) *|* [*ComplexTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/complextransactionargument)

*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*](#cddclaim) *|* [*InvestorUniquenessV2Claim*](#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/trustedclaimissuer)\[], `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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/trustedclaimissuer)\[] |
| `claimIssuers`        | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]                                                                   |

**Returns:** *boolean*

### `Const` areSameClaims

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

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

**Parameters:**

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

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

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

**Returns:** *boolean*

### `Const` areSameTargets

▸ **areSameTargets**(`targets`: [CorporateActionTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/corporateactiontargets), `newTargets`: [InputTargets](#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/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-v8/classes/context)): *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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context) |

**Returns:** *object*

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

### createProcedureMethod

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **Storage**›(`args`: object, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)): [*ProcedureMethod*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod)*‹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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)

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

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **ReturnValue**, **Storage**›(`args`: object, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)): [*ProcedureMethod*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod)*‹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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)

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

### `Const` findClaimsByOtherIssuers

▸ **findClaimsByOtherIssuers**(`claims`: [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/claimtarget)\[], `claimsByDid`: Record‹string, MiddlewareClaim\[]›): [*Claim*](#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/claimtarget)\[] |
| `claimsByDid` | Record‹string, MiddlewareClaim\[]›                                                                              |

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

### `Const` findPositiveBalanceIuClaims

▸ **findPositiveBalanceIuClaims**(`claims`: [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/claimtarget)\[], `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)): *Promise‹*[*Claim*](#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/claimtarget)\[] |
| `context` | [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)               |

**Returns:** *Promise‹*[*Claim*](#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*](#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*](#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/txgroup)): *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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/enums/txgroup) |

**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)