# Globals ## Index ### Enumerations * [AffirmationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/affirmationstatus) * [AuthorizationType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/authorizationtype) * [ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/claimtype) * [ConditionTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/conditiontarget) * [ConditionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/conditiontype) * [CountryCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/countrycode) * [ErrorCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/errorcode) * [InstructionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/instructionstatus) * [InstructionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/instructiontype) * [KnownTokenType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/knowntokentype) * [ProposalStage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/proposalstage) * [RoleType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/roletype) * [ScopeType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/scopetype) * [StoStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/stostatus) * [TickerReservationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/tickerreservationstatus) * [TokenIdentifierType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/tokenidentifiertype) * [TransactionArgumentType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/transactionargumenttype) * [TransactionQueueStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/transactionqueuestatus) * [TransactionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/transactionstatus) * [TransferStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/transferstatus) * [TxGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/txgroup) * [VenueType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/venuetype) ### Classes * [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/account) * [AuthorizationRequest](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/authorizationrequest) * [Authorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/authorizations) * [Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/claims) * [Compliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/compliance) * [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context) * [Count](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/count) * [CurrentAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/currentaccount) * [CurrentIdentity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/currentidentity) * [DefaultPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/defaultportfolio) * [DefaultTrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/defaulttrustedclaimissuer) * [Documents](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/documents) * [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity) * [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/identity) * [IdentityAuthorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/identityauthorizations) * [Instruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/instruction) * [Issuance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/issuance) * [Middleware](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/middleware) * [NumberedPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/numberedportfolio) * [Offerings](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/offerings) * [Percentage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/percentage) * [Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/polymesh) * [PolymeshError](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/polymesherror) * [PolymeshTransaction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/polymeshtransaction) * [PolymeshTransactionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/polymeshtransactionbase) * [PolymeshTransactionBatch](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/polymeshtransactionbatch) * [Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/portfolio) * [Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/portfolios) * [Requirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/requirements) * [SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken) * [Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/settlements) * [Sto](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/sto) * [TickerReservation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/tickerreservation) * [TokenHolders](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/tokenholders) * [TransactionQueue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/transactionqueue) * [TransferRestrictionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/transferrestrictionbase) * [TransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/transferrestrictions) * [TrustedClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/trustedclaimissuers) * [Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/venue) ### Interfaces * [AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/accountbalance) * [AccountData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/accountdata) * [ActiveTransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/activetransferrestrictions) * [AddBatchTransactionOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addbatchtransactionopts) * [AddClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addclaimsparams) * [AddInstructionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addinstructionparams) * [AddInvestorUniquenessClaimParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addinvestoruniquenessclaimparams) * [AddTransactionOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addtransactionopts) * [AddTransactionOptsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addtransactionoptsbase) * [ArrayTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/arraytransactionargument) * [CddProviderRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/cddproviderrole) * [ClaimData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimdata) * [ClaimScope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimscope) * [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget) * [ComplexTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/complextransactionargument) * [ConditionCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/conditioncompliance) * [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/connectparamsbase) * [ConstructorParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/constructorparams) * [ConsumeParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/consumeparams) * [CountTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/counttransferrestriction) * [CountTransferRestrictionInput](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/counttransferrestrictioninput) * [CreateSecurityTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/createsecuritytokenparams) * [CreateVenueParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/createvenueparams) * [DeletePortfolioParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/deleteportfolioparams) * [EditClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/editclaimsparams) * [EventIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/eventidentifier) * [ExtrinsicData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/extrinsicdata) * [Fees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/fees) * [HistoricSettlement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/historicsettlement) * [IdentityBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/identitybalance) * [IdentityWithClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/identitywithclaims) * [InstructionAffirmation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/instructionaffirmation) * [Investment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/investment) * [InviteAccountParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/inviteaccountparams) * [IssueTokensParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/issuetokensparams) * [KeyringPair](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/keyringpair) * [Leg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/leg) * [MiddlewareConfig](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/middlewareconfig) * [ModifyInstructionAffirmationParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/modifyinstructionaffirmationparams) * [ModifyPrimaryIssuanceAgentParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/modifyprimaryissuanceagentparams) * [ModifySignerPermissionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/modifysignerpermissionsparams) * [ModifyTokenTrustedClaimIssuersAddSetParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/modifytokentrustedclaimissuersaddsetparams) * [ModifyTokenTrustedClaimIssuersRemoveParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/modifytokentrustedclaimissuersremoveparams) * [MoveFundsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/movefundsparams) * [NetworkProperties](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/networkproperties) * [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions) * [PercentageTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/percentagetransferrestriction) * [PercentageTransferRestrictionInput](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/percentagetransferrestrictioninput) * [Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/permissions) * [PermissionsLike](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/permissionslike) * [PlainTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/plaintransactionargument) * [PortfolioBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliobalance) * [PortfolioCustodianRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliocustodianrole) * [PortfolioMovement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliomovement) * [ProcedureAuthorizationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/procedureauthorizationstatus) * [ProposalDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/proposaldetails) * [ProposalTimeFrames](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/proposaltimeframes) * [ProposalVote](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/proposalvote) * [RedeemTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/redeemtokenparams) * [RegisterIdentityParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/registeridentityparams) * [RemoveSecondaryKeysParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/removesecondarykeysparams) * [RenamePortfolioParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/renameportfolioparams) * [Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/requirement) * [RequirementCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/requirementcompliance) * [ReserveTickerParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/reservetickerparams) * [ResultSet](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/resultset) * [RevokeClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/revokeclaimsparams) * [Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/scope) * [SecondaryKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/secondarykey) * [SecurityTokenDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/securitytokendetails) * [SetAssetRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setassetrequirementsparams) * [SetCountTransferRestrictionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setcounttransferrestrictionsparams) * [SetCustodianParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setcustodianparams) * [SetPercentageTransferRestrictionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setpercentagetransferrestrictionsparams) * [SetTokenDocumentsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/settokendocumentsparams) * [SettlementLeg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/settlementleg) * [SimpleEnumTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/simpleenumtransactionargument) * [StoDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stodetails) * [StoTier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stotier) * [StoWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/stowithdetails) * [TickerOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tickerownerrole) * [TickerReservationDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tickerreservationdetails) * [Tier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tier) * [ToggleFreezeStoParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/togglefreezestoparams) * [ToggleFreezeTransfersParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/togglefreezetransfersparams) * [TogglePauseRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/togglepauserequirementsparams) * [TokenDocument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokendocument) * [TokenHolderOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenholderoptions) * [TokenHolderProperties](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenholderproperties) * [TokenIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenidentifier) * [TokenOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenownerrole) * [TokenPiaRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenpiarole) * [TransferPolyXParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/transferpolyxparams) * [TransferRestrictionInputBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/transferrestrictioninputbase) * [TransferTokenOwnershipParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/transfertokenownershipparams) * [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer) * [UiKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/uikeyring) * [UniqueIdentifiers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/uniqueidentifiers) * [VenueDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/venuedetails) * [VenueOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/venueownerrole) ### Type aliases * [AddCountTransferRestrictionParams](#addcounttransferrestrictionparams) * [AddPercentageTransferRestrictionParams](#addpercentagetransferrestrictionparams) * [AddRestrictionParams](#addrestrictionparams) * [Authorization](#authorization) * [CddClaim](#cddclaim) * [Claim](#claim) * [CommonKeyring](#commonkeyring) * [Condition](#condition) * [ConditionBase](#conditionbase) * [Ensured](#ensured) * [GetReturnType](#getreturntype) * [IdentityCondition](#identitycondition) * [InstructionDetails](#instructiondetails) * [InvestorUniquenessClaim](#investoruniquenessclaim) * [ModifyClaimsParams](#modifyclaimsparams) * [ModifyStoTimesParams](#modifystotimesparams) * [ModifyTokenParams](#modifytokenparams) * [MultiClaimCondition](#multiclaimcondition) * [Mutable](#mutable) * [NextKey](#nextkey) * [PortfolioLike](#portfoliolike) * [PrimaryIssuanceAgentCondition](#primaryissuanceagentcondition) * [Role](#role) * [ScopedClaim](#scopedclaim) * [SetRestrictionsParams](#setrestrictionsparams) * [SetTransferRestrictionsParams](#settransferrestrictionsparams) * [Signer](#signer) * [SingleClaimCondition](#singleclaimcondition) * [SubCallback](#subcallback) * [TokenType](#tokentype) * [TransactionArgument](#transactionargument) * [UnionOfProcedures](#unionofprocedures) * [UnscopedClaim](#unscopedclaim) * [UnsubCallback](#unsubcallback) ### Functions * [areSameClaimIssuers](#const-aresameclaimissuers) * [areSameClaims](#const-aresameclaims) * [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 ### AddCountTransferRestrictionParams Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/counttransferrestrictioninput) *& object* *Defined in* [*src/api/procedures/addTransferRestriction.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/addTransferRestriction.ts#L24) ### AddPercentageTransferRestrictionParams Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/percentagetransferrestrictioninput) *& object* *Defined in* [*src/api/procedures/addTransferRestriction.ts:28*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/addTransferRestriction.ts#L28) ### AddRestrictionParams Ƭ **AddRestrictionParams**: *Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›* *Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:29*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L29) ### Authorization Ƭ **Authorization**: *object | object | object | object* *Defined in* [*src/types/index.ts:232*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L232) Authorization request data corresponding to type ### CddClaim Ƭ **CddClaim**: *object* *Defined in* [*src/types/index.ts:278*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L278) #### Type declaration: * **id**: *string* * **type**: [*CustomerDueDiligence*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/claimtype#customerduediligence) ### Claim Ƭ **Claim**: [*ScopedClaim*](#scopedclaim) *|* [*UnscopedClaim*](#unscopedclaim) *Defined in* [*src/types/index.ts:303*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L303) ### CommonKeyring Ƭ **CommonKeyring**: *Pick‹Keyring, "getPair" | "getPairs" | "addFromSeed" | "addFromUri" | "addFromMnemonic"›* *Defined in* [*src/types/index.ts:487*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L487) ### Condition Ƭ **Condition**: [*SingleClaimCondition*](#singleclaimcondition) *|* [*MultiClaimCondition*](#multiclaimcondition) *|* [*IdentityCondition*](#identitycondition) *|* [*PrimaryIssuanceAgentCondition*](#primaryissuanceagentcondition) *Defined in* [*src/types/index.ts:389*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L389) ### ConditionBase Ƭ **ConditionBase**: *object* *Defined in* [*src/types/index.ts:368*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L368) #### Type declaration: * **target**: [*ConditionTarget*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/conditiontarget) * **trustedClaimIssuers**? : [*TrustedClaimIssuer*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer)*\[]* ### Ensured Ƭ **Ensured**: *Required‹Pick‹T, K››* *Defined in* [*src/types/index.ts:480*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L480) ### GetReturnType Ƭ **GetReturnType**: [*ActiveTransferRestrictions*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/activetransferrestrictions)*‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›* *Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:43*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L43) ### IdentityCondition Ƭ **IdentityCondition**: [*ConditionBase*](#conditionbase) *& object* *Defined in* [*src/types/index.ts:380*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L380) ### InstructionDetails Ƭ **InstructionDetails**: *object & object | object* *Defined in* [*src/api/entities/Instruction/types.ts:15*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/types.ts#L15) ### InvestorUniquenessClaim Ƭ **InvestorUniquenessClaim**: *object* *Defined in* [*src/types/index.ts:280*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L280) #### Type declaration: * **cddId**: *string* * **scope**: [*Scope*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/scope) * **scopeId**: *string* * **type**: [*InvestorUniqueness*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/claimtype#investoruniqueness) ### ModifyClaimsParams Ƭ **ModifyClaimsParams**: [*AddClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addclaimsparams) *|* [*EditClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/editclaimsparams) *|* [*RevokeClaimsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/revokeclaimsparams) *Defined in* [*src/api/procedures/modifyClaims.ts:54*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/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/a0872cf4/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/a0872cf4/src/api/procedures/modifyToken.ts#L13) ### MultiClaimCondition Ƭ **MultiClaimCondition**: [*ConditionBase*](#conditionbase) *& object* *Defined in* [*src/types/index.ts:375*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L375) ### Mutable Ƭ **Mutable**: *object* *Defined in* [*src/types/utils/index.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/utils/index.ts#L3) #### Type declaration: ### NextKey Ƭ **NextKey**: *string | number | null* *Defined in* [*src/types/index.ts:516*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L516) ### PortfolioLike Ƭ **PortfolioLike**: *string |* [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/identity) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/numberedportfolio) *|* [*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/defaultportfolio) *| object* *Defined in* [*src/types/index.ts:705*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L705) ### PrimaryIssuanceAgentCondition Ƭ **PrimaryIssuanceAgentCondition**: [*ConditionBase*](#conditionbase) *& object* *Defined in* [*src/types/index.ts:385*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L385) ### Role Ƭ **Role**: [*TickerOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tickerownerrole) *|* [*TokenOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenownerrole) *|* [*TokenPiaRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokenpiarole) *|* [*CddProviderRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/cddproviderrole) *|* [*VenueOwnerRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/venueownerrole) *|* [*PortfolioCustodianRole*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliocustodianrole) *Defined in* [*src/types/index.ts:159*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L159) ### ScopedClaim Ƭ **ScopedClaim**: *object |* [*InvestorUniquenessClaim*](#investoruniquenessclaim) *| object* *Defined in* [*src/types/index.ts:287*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L287) ### SetRestrictionsParams Ƭ **SetRestrictionsParams**: *Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›* *Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L36) ### SetTransferRestrictionsParams Ƭ **SetTransferRestrictionsParams**: *object &* [*SetCountTransferRestrictionsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setcounttransferrestrictionsparams) *|* [*SetPercentageTransferRestrictionsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setpercentagetransferrestrictionsparams) *Defined in* [*src/api/procedures/setTransferRestrictions.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/setTransferRestrictions.ts#L36) ### Signer Ƭ **Signer**: [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/identity) *|* [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/account) *Defined in* [*src/types/index.ts:615*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L615) ### SingleClaimCondition Ƭ **SingleClaimCondition**: [*ConditionBase*](#conditionbase) *& object* *Defined in* [*src/types/index.ts:370*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L370) ### SubCallback Ƭ **SubCallback**: *function* *Defined in* [*src/types/index.ts:476*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L476) #### Type declaration: ▸ (`result`: T): *void | Promise‹void›* **Parameters:** | Name | Type | | -------- | ---- | | `result` | T | ### TokenType Ƭ **TokenType**: [*KnownTokenType*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/knowntokentype) *| object* *Defined in* [*src/types/index.ts:182*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L182) Type of security that the token represents ### TransactionArgument Ƭ **TransactionArgument**: *object &* [*PlainTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/plaintransactionargument) *|* [*ArrayTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/arraytransactionargument) *|* [*SimpleEnumTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/simpleenumtransactionargument) *|* [*ComplexTransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/complextransactionargument) *Defined in* [*src/types/index.ts:604*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L604) ### UnionOfProcedures Ƭ **UnionOfProcedures**: *Args extends unknown ? Procedure‹Args, ReturnValue, Storage› : never* *Defined in* [*src/types/utils/index.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/utils/index.ts#L7) ### UnscopedClaim Ƭ **UnscopedClaim**: *object |* [*CddClaim*](#cddclaim) *Defined in* [*src/types/index.ts:301*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L301) ### UnsubCallback Ƭ **UnsubCallback**: *function* *Defined in* [*src/types/index.ts:478*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L478) #### Type declaration: ▸ (): *void* ## Functions ### `Const` areSameClaimIssuers ▸ **areSameClaimIssuers**(`currentClaimIssuers`: [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer)\[], `claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]): *boolean* *Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L65) **Parameters:** | Name | Type | | --------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `currentClaimIssuers` | [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/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/a0872cf4/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-v4/interfaces/scope)› | | `type` | ClaimTypeEnum | **Returns:** *boolean* ### `Const` convertArgsToRaw ▸ **convertArgsToRaw**(`claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"], `rawTicker`: Ticker, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context)): *object* *Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/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-v4/classes/context) | **Returns:** *object* * **claimIssuersToAdd**: *\[Ticker, TrustedIssuer]\[]* * **inputDids**: *string\[]* ### createProcedureMethod ▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ReturnValue**, **Storage**›(`getProcedureAndArgs`: function, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context)): *ProcedureMethod‹MethodArgs, ReturnValue›* *Defined in* [*src/utils/internal.ts:377*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/utils/internal.ts#L377) Create a method that prepares a procedure **Type parameters:** ▪ **MethodArgs** ▪ **ProcedureArgs**: *unknown* ▪ **ReturnValue** ▪ **Storage** **Parameters:** ▪ **getProcedureAndArgs**: *function* ▸ (`args`: MethodArgs): *\[*[*UnionOfProcedures*](#unionofprocedures)*‹ProcedureArgs, ReturnValue, Storage› | Procedure‹ProcedureArgs, ReturnValue, Storage›, ProcedureArgs]* **Parameters:** | Name | Type | | ------ | ---------- | | `args` | MethodArgs | ▪ **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context) **Returns:** *ProcedureMethod‹MethodArgs, ReturnValue›* ### `Const` findClaimsByOtherIssuers ▸ **findClaimsByOtherIssuers**(`claims`: [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget)\[], `claimsByDid`: Record‹string, MiddlewareClaim\[]›): [*Claim*](#claim)*\[]* *Defined in* [*src/api/procedures/modifyClaims.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyClaims.ts#L75) **Parameters:** | Name | Type | | ------------- | --------------------------------------------------------------------------------------------------------------- | | `claims` | [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget)\[] | | `claimsByDid` | Record‹string, MiddlewareClaim\[]› | **Returns:** [*Claim*](#claim)*\[]* ### `Const` findPositiveBalanceIuClaims ▸ **findPositiveBalanceIuClaims**(`claims`: [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget)\[], `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context)): *Promise‹*[*Claim*](#claim)*\[]›* *Defined in* [*src/api/procedures/modifyClaims.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyClaims.ts#L91) **Parameters:** | Name | Type | | --------- | --------------------------------------------------------------------------------------------------------------- | | `claims` | [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget)\[] | | `context` | [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context) | **Returns:** *Promise‹*[*Claim*](#claim)*\[]›* ### tickerToDid ▸ **tickerToDid**(`ticker`: string): *string* *Defined in* [*src/utils/conversion.ts:181*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/utils/conversion.ts#L181) 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:16*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/utils/index.ts#L16) 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-v4/enums/txgroup)): *TxTag\[]* *Defined in* [*src/utils/conversion.ts:525*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/utils/conversion.ts#L525) Retrieve every Transaction Tag associated to a Transaction Group **Parameters:** | Name | Type | | ------- | ----------------------------------------------------------------------------------------------- | | `group` | [TxGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/enums/txgroup) | **Returns:** *TxTag\[]* ## Object literals ### `Const` ErrorMessagesPerCode ### ▪ **ErrorMessagesPerCode**: *object* *Defined in* [*src/base/PolymeshError.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/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/a0872cf4/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/a0872cf4/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/a0872cf4/src/base/PolymeshError.ts#L6)