> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md).

# Globals

## Index

### Enumerations

* [AuthorizationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/authorizationstatus.md)
* [AuthorizationType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/authorizationtype.md)
* [ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/claimtype.md)
* [ConditionTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/conditiontarget.md)
* [ConditionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/conditiontype.md)
* [CountryCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/countrycode.md)
* [ErrorCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/errorcode.md)
* [InstructionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/instructionstatus.md)
* [InstructionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/instructiontype.md)
* [KnownTokenType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/knowntokentype.md)
* [Permission](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/permission.md)
* [ProposalStage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/proposalstage.md)
* [RoleType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/roletype.md)
* [ScopeType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/scopetype.md)
* [TickerReservationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/tickerreservationstatus.md)
* [TokenIdentifierType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/tokenidentifiertype.md)
* [TransactionArgumentType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/transactionargumenttype.md)
* [TransactionQueueStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/transactionqueuestatus.md)
* [TransactionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/transactionstatus.md)
* [TransferStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/transferstatus.md)
* [VenueType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/venuetype.md)

### Classes

* [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/account.md)
* [AuthorizationRequest](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/authorizationrequest.md)
* [Authorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/authorizations.md)
* [Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/claims.md)
* [Compliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/compliance.md)
* [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/context.md)
* [CurrentAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/currentaccount.md)
* [CurrentIdentity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/currentidentity.md)
* [DefaultPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/defaultportfolio.md)
* [Documents](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/documents.md)
* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/entity.md)
* [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/identity.md)
* [IdentityAuthorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/identityauthorizations.md)
* [Instruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/instruction.md)
* [Issuance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/issuance.md)
* [Middleware](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/middleware.md)
* [NumberedPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/numberedportfolio.md)
* [Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md)
* [PolymeshError](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/polymesherror.md)
* [PolymeshTransaction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/polymeshtransaction.md)
* [Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/portfolio.md)
* [Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/portfolios.md)
* [Requirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/requirements.md)
* [SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)
* [Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/settlements.md)
* [TickerReservation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/tickerreservation.md)
* [TokenHolders](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/tokenholders.md)
* [TransactionQueue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)
* [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/trustedclaimissuer.md)
* [TrustedClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/trustedclaimissuers.md)
* [Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/venue.md)

### Interfaces

* [AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/accountbalance.md)
* [AccountData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/accountdata.md)
* [AddClaimItem](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/addclaimitem.md)
* [AddClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/addclaimsparams.md)
* [AddInstructionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/addinstructionparams.md)
* [AddTransactionOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/addtransactionopts.md)
* [ArrayTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/arraytransactionargument.md)
* [CddProviderRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/cddproviderrole.md)
* [ClaimData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/claimdata.md)
* [ClaimScope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/claimscope.md)
* [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/claimtarget.md)
* [ComplexTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/complextransactionargument.md)
* [ConditionCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/conditioncompliance.md)
* [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/connectparamsbase.md)
* [ConstructorParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/constructorparams.md)
* [ConsumeParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/consumeparams.md)
* [CreateSecurityTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/createsecuritytokenparams.md)
* [CreateVenueParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/createvenueparams.md)
* [DeletePortfolioParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/deleteportfolioparams.md)
* [EditClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/editclaimsparams.md)
* [EventIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/eventidentifier.md)
* [ExtrinsicData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/extrinsicdata.md)
* [Fees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/fees.md)
* [IdentityBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/identitybalance.md)
* [IdentityWithClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/identitywithclaims.md)
* [InstructionAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/instructionauthorization.md)
* [InviteAccountParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/inviteaccountparams.md)
* [IssueTokensParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/issuetokensparams.md)
* [KeyringPair](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/keyringpair.md)
* [Leg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/leg.md)
* [MiddlewareConfig](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/middlewareconfig.md)
* [ModifyInstructionAuthorizationParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/modifyinstructionauthorizationparams.md)
* [ModifyPrimaryIssuanceAgentParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/modifyprimaryissuanceagentparams.md)
* [ModifyTokenTrustedClaimIssuersParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/modifytokentrustedclaimissuersparams.md)
* [MoveFundsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/movefundsparams.md)
* [NetworkProperties](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/networkproperties.md)
* [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/paginationoptions.md)
* [PlainTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/plaintransactionargument.md)
* [PortfolioBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/portfoliobalance.md)
* [PortfolioCustodianRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/portfoliocustodianrole.md)
* [PortfolioMovement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/portfoliomovement.md)
* [ProposalDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/proposaldetails.md)
* [ProposalTimeFrames](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/proposaltimeframes.md)
* [ProposalVote](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/proposalvote.md)
* [RegisterIdentityParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/registeridentityparams.md)
* [RemoveSecondaryKeysParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/removesecondarykeysparams.md)
* [RenamePortfolioParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/renameportfolioparams.md)
* [Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/requirement.md)
* [RequirementCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/requirementcompliance.md)
* [ReserveTickerParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/reservetickerparams.md)
* [ResultSet](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/resultset.md)
* [RevokeClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/revokeclaimsparams.md)
* [Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/scope.md)
* [SecondaryKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/secondarykey.md)
* [SecurityTokenDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/securitytokendetails.md)
* [SetAssetRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/setassetrequirementsparams.md)
* [SetCustodianParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/setcustodianparams.md)
* [SetTokenDocumentsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/settokendocumentsparams.md)
* [SimpleEnumTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/simpleenumtransactionargument.md)
* [TickerOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tickerownerrole.md)
* [TickerReservationDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tickerreservationdetails.md)
* [ToggleFreezeTransfersParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/togglefreezetransfersparams.md)
* [TogglePauseRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/togglepauserequirementsparams.md)
* [TokenDocument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tokendocument.md)
* [TokenHolderOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tokenholderoptions.md)
* [TokenHolderProperties](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tokenholderproperties.md)
* [TokenIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tokenidentifier.md)
* [TokenOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/tokenownerrole.md)
* [TransferPolyXParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/transferpolyxparams.md)
* [TransferTokenOwnershipParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/transfertokenownershipparams.md)
* [UiKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/uikeyring.md)
* [UniqueIdentifiers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/uniqueidentifiers.md)
* [VenueDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/venuedetails.md)
* [VenueOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/venueownerrole.md)

### Type aliases

* [Authorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#authorization)
* [Claim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#claim)
* [CommonKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#commonkeyring)
* [Condition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#condition)
* [ConditionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#conditionbase)
* [Ensured](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#ensured)
* [IdentityCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#identitycondition)
* [InstructionDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#instructiondetails)
* [ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#modifyclaimsparams)
* [ModifyTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#modifytokenparams)
* [MultiClaimCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#multiclaimcondition)
* [Mutable](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#mutable)
* [NextKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#nextkey)
* [PortfolioLike](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#portfoliolike)
* [PrimaryIssuanceAgentCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#primaryissuanceagentcondition)
* [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#role)
* [ScopedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#scopedclaim)
* [Signer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#signer)
* [SingleClaimCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#singleclaimcondition)
* [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)
* [TokenType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#tokentype)
* [TransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#transactionargument)
* [TransactionSpecArray](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#transactionspecarray)
* [UnscopedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#unscopedclaim)
* [UnsubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)

### Functions

* [tickerToDid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#tickertodid)
* [tuple](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#const-tuple)

### Object literals

* [ErrorMessagesPerCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#const-errormessagespercode)

## Type aliases

### Authorization

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

*Defined in* [*src/types/index.ts:214*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L214)

Authorization request data corresponding to type

### Claim

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

*Defined in* [*src/types/index.ts:267*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L267)

### CommonKeyring

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

*Defined in* [*src/types/index.ts:434*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L434)

### Condition

Ƭ **Condition**: [*SingleClaimCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#singleclaimcondition) *|* [*MultiClaimCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#multiclaimcondition) *|* [*IdentityCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#identitycondition) *|* [*PrimaryIssuanceAgentCondition*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#primaryissuanceagentcondition)

*Defined in* [*src/types/index.ts:338*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L338)

### ConditionBase

Ƭ **ConditionBase**: *object*

*Defined in* [*src/types/index.ts:317*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L317)

#### Type declaration:

* **target**: [*ConditionTarget*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/enums/conditiontarget.md)
* **trustedClaimIssuers**? : *string\[]*

### Ensured

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

*Defined in* [*src/types/index.ts:427*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L427)

### IdentityCondition

Ƭ **IdentityCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:329*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L329)

### InstructionDetails

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

*Defined in* [*src/api/entities/Instruction/types.ts:21*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/Instruction/types.ts#L21)

### ModifyClaimsParams

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

*Defined in* [*src/api/procedures/modifyClaims.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/procedures/modifyClaims.ts#L50)

### ModifyTokenParams

Ƭ **ModifyTokenParams**: *object | object | object*

*Defined in* [*src/api/procedures/modifyToken.ts:6*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/procedures/modifyToken.ts#L6)

### MultiClaimCondition

Ƭ **MultiClaimCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:324*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L324)

### Mutable

Ƭ **Mutable**: *object*

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

#### Type declaration:

### NextKey

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

*Defined in* [*src/types/index.ts:460*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L460)

### PortfolioLike

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

*Defined in* [*src/types/index.ts:555*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L555)

### PrimaryIssuanceAgentCondition

Ƭ **PrimaryIssuanceAgentCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:334*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L334)

### Role

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

*Defined in* [*src/types/index.ts:144*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L144)

### ScopedClaim

Ƭ **ScopedClaim**: *object | object*

*Defined in* [*src/types/index.ts:259*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L259)

### Signer

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

*Defined in* [*src/types/index.ts:542*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L542)

### SingleClaimCondition

Ƭ **SingleClaimCondition**: [*ConditionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:319*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L319)

### SubCallback

Ƭ **SubCallback**: *function*

*Defined in* [*src/types/index.ts:423*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L423)

#### Type declaration:

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

**Parameters:**

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

### TokenType

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

*Defined in* [*src/types/index.ts:166*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L166)

Type of security that the token represents

### TransactionArgument

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

*Defined in* [*src/types/index.ts:531*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L531)

### TransactionSpecArray

Ƭ **TransactionSpecArray**: *object*

*Defined in* [*src/base/TransactionQueue.ts:31*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/base/TransactionQueue.ts#L31)

#### Type declaration:

### UnscopedClaim

Ƭ **UnscopedClaim**: *object | object*

*Defined in* [*src/types/index.ts:263*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L263)

### UnsubCallback

Ƭ **UnsubCallback**: *function*

*Defined in* [*src/types/index.ts:425*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/index.ts#L425)

#### Type declaration:

▸ (): *void*

## Functions

### tickerToDid

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

*Defined in* [*src/utils/conversion.ts:132*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/utils/conversion.ts#L132)

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:10*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/types/utils/index.ts#L10)

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*

## Object literals

### `Const` ErrorMessagesPerCode

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

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