# Globals ## Index ### Enumerations * [AffirmationStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/affirmationstatus.md) * [AuthorizationType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md) * [CaCheckpointType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/cacheckpointtype.md) * [CalendarUnit](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/calendarunit.md) * [ClaimType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/claimtype.md) * [ConditionTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/conditiontarget.md) * [ConditionType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/conditiontype.md) * [CorporateActionKind](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/corporateactionkind.md) * [CountryCode](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/countrycode.md) * [ErrorCode](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/errorcode.md) * [InstructionStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/instructionstatus.md) * [InstructionType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/instructiontype.md) * [KnownAssetType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/knownassettype.md) * [OfferingBalanceStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/offeringbalancestatus.md) * [OfferingSaleStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/offeringsalestatus.md) * [OfferingTimingStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/offeringtimingstatus.md) * [PayingAccountType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/payingaccounttype.md) * [PermissionGroupType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/permissiongrouptype.md) * [PermissionType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/permissiontype.md) * [RoleType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/roletype.md) * [ScopeType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/scopetype.md) * [SecurityIdentifierType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/securityidentifiertype.md) * [SignerType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/signertype.md) * [TargetTreatment](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/targettreatment.md) * [TickerReservationStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/tickerreservationstatus.md) * [TransactionArgumentType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/transactionargumenttype.md) * [TransactionQueueStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/transactionqueuestatus.md) * [TransactionStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/transactionstatus.md) * [TransferError](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/transfererror.md) * [TransferRestrictionType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/transferrestrictiontype.md) * [TransferStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/transferstatus.md) * [TxGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/txgroup.md) * [VenueType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/venuetype.md) ### Classes * [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/account) * [AccountManagement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/accountmanagement) * [Asset](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset) * [AssetHolders](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/assetholders) * [AssetPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/assetpermissions) * [Assets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/assets) * [AuthorizationRequest](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/authorizationrequest) * [Authorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/authorizations) * [Checkpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/checkpoint) * [CheckpointSchedule](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule) * [Checkpoints](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/checkpoints) * [Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/claims) * [Compliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/compliance) * [CorporateAction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/corporateaction) * [CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase) * [CorporateActions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/corporateactions) * [Count](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/count) * [CustomPermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/custompermissiongroup) * [DefaultPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/defaultportfolio) * [DefaultTrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/defaulttrustedclaimissuer) * [Distributions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/distributions) * [DividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/dividenddistribution) * [Documents](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/documents) * [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/entity) * [Identities](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identities) * [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identity) * [IdentityAuthorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identityauthorizations) * [Instruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/instruction) * [Issuance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/issuance) * [KnownPermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/knownpermissiongroup) * [Network](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/network) * [NumberedPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/numberedportfolio) * [Offering](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/offering) * [Offerings](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/offerings) * [Percentage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/percentage) * [PermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/permissiongroup) * [Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/permissions) * [Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/polymesh) * [PolymeshError](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/polymesherror) * [PolymeshTransaction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/polymeshtransaction) * [PolymeshTransactionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/polymeshtransactionbase) * [PolymeshTransactionBatch](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/polymeshtransactionbatch) * [Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/portfolio) * [Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/portfolios) * [Requirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/requirements) * [Schedules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/schedules) * [Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/settlements) * [Subsidy](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/subsidy) * [TickerReservation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/tickerreservation) * [TransactionQueue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue) * [TransferRestrictionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transferrestrictionbase) * [TransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transferrestrictions) * [TrustedClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/trustedclaimissuers) * [Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/venue) ### Interfaces * [AccreditedClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/accreditedclaim.md) * [ActiveTransferRestrictions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/activetransferrestrictions.md) * [AddAssetRequirementParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addassetrequirementparams.md) * [AddClaimsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addclaimsparams.md) * [AddInstructionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinstructionparams.md) * [AddInstructionWithVenueIdParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinstructionwithvenueidparams.md) * [AddInstructionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinstructionsparams.md) * [AddInvestorUniquenessClaimParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinvestoruniquenessclaimparams.md) * [AffiliateClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/affiliateclaim.md) * [AffirmInstructionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/affirminstructionparams.md) * [AgentWithGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/agentwithgroup.md) * [ArrayTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/arraytransactionargument.md) * [AssetBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/assetbase.md) * [AssetDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/assetdetails.md) * [AssetDocument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/assetdocument.md) * [AssetWithGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/assetwithgroup.md) * [Balance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/balance.md) * [BlockedClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/blockedclaim.md) * [BuyLockupClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/buylockupclaim.md) * [CalendarPeriod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/calendarperiod.md) * [CalendarPeriodHumanReadable](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/calendarperiodhumanreadable.md) * [CddClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/cddclaim.md) * [CddProviderRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/cddproviderrole.md) * [CheckPermissionsResult](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/checkpermissionsresult.md) * [CheckRolesResult](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/checkrolesresult.md) * [CheckpointWithData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/checkpointwithdata.md) * [ClaimClassicTickerParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimclassictickerparams.md) * [ClaimData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md) * [ClaimScope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimscope.md) * [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimtarget.md) * [ComplexTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/complextransactionargument.md) * [ComplianceRequirements](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/compliancerequirements.md) * [ConditionBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/conditionbase.md) * [ConditionCompliance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/conditioncompliance.md) * [ConnectParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/connectparams.md) * [ConstructorParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/constructorparams.md) * [ConsumeParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/consumeparams.md) * [ControllerTransferParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/controllertransferparams.md) * [CorporateActionDefaultConfig](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/corporateactiondefaultconfig.md) * [CorporateActionTargets](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/corporateactiontargets.md) * [CountTransferRestriction](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/counttransferrestriction.md) * [CountTransferRestrictionInput](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/counttransferrestrictioninput.md) * [CreateAssetParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/createassetparams.md) * [CreateAssetWithTickerParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/createassetwithtickerparams.md) * [CreateCheckpointScheduleParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/createcheckpointscheduleparams.md) * [CreateGroupParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/creategroupparams.md) * [CreateVenueParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/createvenueparams.md) * [DecreaseAllowanceParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/decreaseallowanceparams.md) * [DeletePortfolioParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/deleteportfolioparams.md) * [DistributionParticipant](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionparticipant.md) * [DistributionPayment](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionpayment.md) * [DistributionWithDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionwithdetails.md) * [DividendDistributionDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/dividenddistributiondetails.md) * [DividendDistributionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/dividenddistributionparams.md) * [EditClaimsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/editclaimsparams.md) * [EventIdentifier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/eventidentifier.md) * [ExemptedClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/exemptedclaim.md) * [ExternalAgentCondition](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/externalagentcondition.md) * [ExtrinsicData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/extrinsicdata.md) * [ExtrinsicDataWithFees](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/extrinsicdatawithfees.md) * [Fees](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/fees.md) * [FeesBreakdown](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/feesbreakdown.md) * [GroupedInstructions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/groupedinstructions.md) * [HistoricAgentOperation](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/historicagentoperation.md) * [HistoricSettlement](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/historicsettlement.md) * [HumanReadable](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/humanreadable.md) * [IdentityBalance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitybalance.md) * [IdentityCondition](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitycondition.md) * [IdentityRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identityrole.md) * [IdentityWithClaims](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md) * [IncreaseAllowanceParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/increaseallowanceparams.md) * [InstructionAffirmation](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/instructionaffirmation.md) * [InvestInOfferingParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investinofferingparams.md) * [Investment](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investment.md) * [InvestorUniquenessClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investoruniquenessclaim.md) * [InvestorUniquenessV2Claim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investoruniquenessv2claim.md) * [InviteAccountParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/inviteaccountparams.md) * [InviteExternalAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/inviteexternalagentparams.md) * [IssueTokensParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/issuetokensparams.md) * [JurisdictionClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/jurisdictionclaim.md) * [KycClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/kycclaim.md) * [Leg](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/leg.md) * [LinkCaDocsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/linkcadocsparams.md) * [MiddlewareConfig](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/middlewareconfig.md) * [ModifyAssetTrustedClaimIssuersAddSetParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/modifyassettrustedclaimissuersaddsetparams.md) * [ModifyAssetTrustedClaimIssuersRemoveParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/modifyassettrustedclaimissuersremoveparams.md) * [ModifyCorporateActionsAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/modifycorporateactionsagentparams.md) * [ModifyInstructionAffirmationParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/modifyinstructionaffirmationparams.md) * [ModifyPrimaryIssuanceAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/modifyprimaryissuanceagentparams.md) * [ModifySignerPermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/modifysignerpermissionsparams.md) * [MoveFundsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/movefundsparams.md) * [MultiClaimCondition](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/multiclaimcondition.md) * [NetworkProperties](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/networkproperties.md) * [NoArgsProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md) * [NoDataClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/nodataclaim.md) * [OfferingDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/offeringdetails.md) * [OfferingStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/offeringstatus.md) * [OfferingTier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/offeringtier.md) * [OfferingWithDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/offeringwithdetails.md) * [PaginationOptions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/paginationoptions.md) * [PayDividendsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/paydividendsparams.md) * [PayingAccount](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/payingaccount.md) * [PercentageTransferRestriction](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/percentagetransferrestriction.md) * [PercentageTransferRestrictionInput](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/percentagetransferrestrictioninput.md) * [PermissionGroups](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissiongroups.md) * [PermissionedAccount](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md) * [PlainTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/plaintransactionargument.md) * [PortfolioBalance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/portfoliobalance.md) * [PortfolioCustodianRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/portfoliocustodianrole.md) * [PortfolioMovement](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/portfoliomovement.md) * [ProcedureAuthorizationStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureauthorizationstatus.md) * [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md) * [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) * [ProtocolFees](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/protocolfees.md) * [QuitSubsidyParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/quitsubsidyparams.md) * [RedeemTokensParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/redeemtokensparams.md) * [RegisterIdentityParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/registeridentityparams.md) * [RemoveAssetRequirementParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/removeassetrequirementparams.md) * [RemoveCheckpointScheduleParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/removecheckpointscheduleparams.md) * [RemoveCorporateActionParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/removecorporateactionparams.md) * [RemoveExternalAgentParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/removeexternalagentparams.md) * [RemoveSecondaryAccountsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/removesecondaryaccountsparams.md) * [RenamePortfolioParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/renameportfolioparams.md) * [Requirement](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/requirement.md) * [RequirementCompliance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/requirementcompliance.md) * [ReserveTickerParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/reservetickerparams.md) * [ResultSet](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md) * [RevokeClaimsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/revokeclaimsparams.md) * [ScheduleDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/scheduledetails.md) * [ScheduleWithDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/schedulewithdetails.md) * [Scope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/scope.md) * [SectionPermissions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/sectionpermissions.md) * [SecurityIdentifier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/securityidentifier.md) * [SellLockupClaim](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/selllockupclaim.md) * [SetAllowanceParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setallowanceparams.md) * [SetAssetDocumentsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setassetdocumentsparams.md) * [SetAssetRequirementsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setassetrequirementsparams.md) * [SetCountTransferRestrictionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setcounttransferrestrictionsparams.md) * [SetCustodianParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setcustodianparams.md) * [SetGroupPermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setgrouppermissionsparams.md) * [SetPercentageTransferRestrictionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setpercentagetransferrestrictionsparams.md) * [SetPermissionGroupParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setpermissiongroupparams.md) * [SettlementLeg](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/settlementleg.md) * [SignerValue](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/signervalue.md) * [SimpleEnumTransactionArgument](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/simpleenumtransactionargument.md) * [SimplePermissions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/simplepermissions.md) * [SingleClaimCondition](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/singleclaimcondition.md) * [SubsidizeAccountParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/subsidizeaccountparams.md) * [SubsidyData](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/subsidydata.md) * [SubsidyWithAllowance](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/subsidywithallowance.md) * [TaxWithholding](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/taxwithholding.md) * [ThirdPartyFees](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/thirdpartyfees.md) * [TickerOwnerRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/tickerownerrole.md) * [TickerReservationDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/tickerreservationdetails.md) * [Tier](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/tier.md) * [ToggleFreezeOfferingParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/togglefreezeofferingparams.md) * [ToggleFreezeSecondaryAccountsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/togglefreezesecondaryaccountsparams.md) * [ToggleFreezeTransfersParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/togglefreezetransfersparams.md) * [TogglePauseRequirementsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/togglepauserequirementsparams.md) * [TransactionPermissions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transactionpermissions.md) * [TransactionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transactionsparams.md) * [TransferAssetOwnershipParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transferassetownershipparams.md) * [TransferBreakdown](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transferbreakdown.md) * [TransferPolyxParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transferpolyxparams.md) * [TransferRestriction](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transferrestriction.md) * [TransferRestrictionInputBase](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transferrestrictioninputbase.md) * [TransferRestrictionResult](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transferrestrictionresult.md) * [TransferTickerOwnershipParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/transfertickerownershipparams.md) * [TrustedClaimIssuer](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/trustedclaimissuer.md) * [TxAndArgsArray](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/txandargsarray.md) * [TxGroupParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/txgroupparams.md) * [UniqueIdentifiers](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/uniqueidentifiers.md) * [VenueDetails](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/venuedetails.md) * [VenueOwnerRole](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/venueownerrole.md) * [WaivePermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/waivepermissionsparams.md) ### Type aliases * [AccountBalance](#accountbalance) * [AddCountTransferRestrictionParams](#addcounttransferrestrictionparams) * [AddPercentageTransferRestrictionParams](#addpercentagetransferrestrictionparams) * [AddRelayerPayingKeyAuthorizationData](#addrelayerpayingkeyauthorizationdata) * [AddRestrictionParams](#addrestrictionparams) * [ArgsType](#argstype) * [Authorization](#authorization) * [BecomeAgentAuthorizationData](#becomeagentauthorizationdata) * [CheckpointScheduleParams](#checkpointscheduleparams) * [Claim](#claim) * [Condition](#condition) * [ConfigureDividendDistributionParams](#configuredividenddistributionparams) * [Ensured](#ensured) * [EnsuredV2](#ensuredv2) * [GenericAuthorizationData](#genericauthorizationdata) * [GetReturnType](#getreturntype) * [GroupPermissions](#grouppermissions) * [HumanReadableType](#humanreadabletype) * [InputCaCheckpoint](#inputcacheckpoint) * [InputCondition](#inputcondition) * [InputConditionBase](#inputconditionbase) * [InputRequirement](#inputrequirement) * [InputTargets](#inputtargets) * [InputTaxWithholding](#inputtaxwithholding) * [InputTrustedClaimIssuer](#inputtrustedclaimissuer) * [InstructionDetails](#instructiondetails) * [InstructionStatusResult](#instructionstatusresult) * [JoinIdentityAuthorizationData](#joinidentityauthorizationdata) * [MapTxAndArgsArray](#maptxandargsarray) * [Modify](#modify) * [ModifyAllowanceParams](#modifyallowanceparams) * [ModifyAssetParams](#modifyassetparams) * [ModifyCaDefaultConfigParams](#modifycadefaultconfigparams) * [ModifyClaimsParams](#modifyclaimsparams) * [ModifyComplianceRequirementParams](#modifycompliancerequirementparams) * [ModifyOfferingTimesParams](#modifyofferingtimesparams) * [ModifyVenueParams](#modifyvenueparams) * [Mutable](#mutable) * [NextKey](#nextkey) * [PaginatedQueryArgs](#paginatedqueryargs) * [PermissionsLike](#permissionslike) * [PortfolioCustodyAuthorizationData](#portfoliocustodyauthorizationdata) * [PortfolioLike](#portfoliolike) * [PrivateKey](#privatekey) * [ProcedureFunc](#procedurefunc) * [QueryArgs](#queryargs) * [QueryReturnType](#queryreturntype) * [Role](#role) * [RotatePrimaryKeyAuthorizationData](#rotateprimarykeyauthorizationdata) * [RotatePrimaryKeyToSecondaryData](#rotateprimarykeytosecondarydata) * [ScopedClaim](#scopedclaim) * [SetRestrictionsParams](#setrestrictionsparams) * [SetTransferRestrictionsParams](#settransferrestrictionsparams) * [Signer](#signer) * [SubCallback](#subcallback) * [TransactionArgument](#transactionargument) * [UnionOfProcedureFuncs](#unionofprocedurefuncs) * [UnscopedClaim](#unscopedclaim) * [UnsubCallback](#unsubcallback) * [WithRequired](#withrequired) ### Variables * [caNotExistsMessage](#const-canotexistsmessage) * [executedMessage](#const-executedmessage) * [notExistsMessage](#const-notexistsmessage) ### Functions * [areSameClaimIssuers](#const-aresameclaimissuers) * [areSameClaims](#const-aresameclaims) * [areSameTargets](#const-aresametargets) * [assembleBatchTransactions](#assemblebatchtransactions) * [convertArgsToRaw](#const-convertargstoraw) * [createProcedureMethod](#createproceduremethod) * [findClaimsByOtherIssuers](#const-findclaimsbyotherissuers) * [findPositiveBalanceIuClaims](#const-findpositivebalanceiuclaims) * [isAccount](#isaccount) * [isAccreditedClaim](#isaccreditedclaim) * [isAffiliateClaim](#isaffiliateclaim) * [isAsset](#isasset) * [isAuthorizationRequest](#isauthorizationrequest) * [isBlockedClaim](#isblockedclaim) * [isBuyLockupClaim](#isbuylockupclaim) * [isCddClaim](#iscddclaim) * [isCddProviderRole](#iscddproviderrole) * [isCheckpoint](#ischeckpoint) * [isCheckpointSchedule](#ischeckpointschedule) * [isCorporateAction](#iscorporateaction) * [isCustomPermissionGroup](#iscustompermissiongroup) * [isDefaultPortfolio](#isdefaultportfolio) * [isDefaultTrustedClaimIssuer](#isdefaulttrustedclaimissuer) * [isDividendDistribution](#isdividenddistribution) * [isEntity](#isentity) * [isExemptedClaim](#isexemptedclaim) * [isIdentity](#isidentity) * [isIdentityCondition](#isidentitycondition) * [isIdentityRole](#isidentityrole) * [isInstruction](#isinstruction) * [isInvestorUniquenessClaim](#isinvestoruniquenessclaim) * [isInvestorUniquenessV2Claim](#isinvestoruniquenessv2claim) * [isJurisdictionClaim](#isjurisdictionclaim) * [isKnownPermissionGroup](#isknownpermissiongroup) * [isKycClaim](#iskycclaim) * [isMultiClaimCondition](#ismulticlaimcondition) * [isNoDataClaim](#isnodataclaim) * [isNumberedPortfolio](#isnumberedportfolio) * [isOffering](#isoffering) * [isPolymeshError](#ispolymesherror) * [isPolymeshTransaction](#ispolymeshtransaction) * [isPolymeshTransactionBatch](#ispolymeshtransactionbatch) * [isPortfolioCustodianRole](#isportfoliocustodianrole) * [isScopedClaim](#isscopedclaim) * [isSellLockupClaim](#isselllockupclaim) * [isSingleClaimCondition](#issingleclaimcondition) * [isTickerOwnerRole](#istickerownerrole) * [isTickerReservation](#istickerreservation) * [isUnscopedClaim](#isunscopedclaim) * [isVenue](#isvenue) * [isVenueOwnerRole](#isvenueownerrole) * [tickerToDid](#tickertodid) * [tuple](#const-tuple) * [txGroupToTxTags](#txgrouptotxtags) ### Object literals * [defaultMessages](#const-defaultmessages) ## Type aliases ### AccountBalance Ƭ **AccountBalance**: [*Balance*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/balance.md) *Defined in* [*src/types/index.ts:674*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L674) *** ### AddCountTransferRestrictionParams Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/counttransferrestrictioninput.md) *& object* *Defined in* [*src/api/procedures/addTransferRestriction.ts:21*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/addTransferRestriction.ts#L21) *** ### AddPercentageTransferRestrictionParams Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/percentagetransferrestrictioninput.md) *& object* *Defined in* [*src/api/procedures/addTransferRestriction.ts:25*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/addTransferRestriction.ts#L25) *** ### AddRelayerPayingKeyAuthorizationData Ƭ **AddRelayerPayingKeyAuthorizationData**: *object* *Defined in* [*src/types/index.ts:1054*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1054) #### Type declaration: * **type**: [*AddRelayerPayingKey*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#addrelayerpayingkey) * **value**: [*SubsidyData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/subsidydata.md) *** ### AddRestrictionParams Ƭ **AddRestrictionParams**: *Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›* *Defined in* [*src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:35*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts#L35) *** ### ArgsType Ƭ **ArgsType**: *T extends function ? A : never* *Defined in* [*src/types/utils/index.ts:20*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L20) Less strict version of Parameters *** ### Authorization Ƭ **Authorization**: [*RotatePrimaryKeyAuthorizationData*](#rotateprimarykeyauthorizationdata) *|* [*JoinIdentityAuthorizationData*](#joinidentityauthorizationdata) *|* [*PortfolioCustodyAuthorizationData*](#portfoliocustodyauthorizationdata) *|* [*BecomeAgentAuthorizationData*](#becomeagentauthorizationdata) *|* [*AddRelayerPayingKeyAuthorizationData*](#addrelayerpayingkeyauthorizationdata) *|* [*RotatePrimaryKeyToSecondaryData*](#rotateprimarykeytosecondarydata) *|* [*GenericAuthorizationData*](#genericauthorizationdata) *Defined in* [*src/types/index.ts:1074*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1074) Authorization request data corresponding to type *** ### BecomeAgentAuthorizationData Ƭ **BecomeAgentAuthorizationData**: *object* *Defined in* [*src/types/index.ts:1049*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1049) #### Type declaration: * **type**: [*BecomeAgent*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#becomeagent) * **value**: [*KnownPermissionGroup*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/knownpermissiongroup) *|* [*CustomPermissionGroup*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/custompermissiongroup) *** ### CheckpointScheduleParams Ƭ **CheckpointScheduleParams**: *Omit‹*[*UniqueIdentifiers*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/uniqueidentifiers.md) *& Params, "ticker"›* *Defined in* [*src/api/entities/CheckpointSchedule/types.ts:10*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CheckpointSchedule/types.ts#L10) *** ### Claim Ƭ **Claim**: [*ScopedClaim*](#scopedclaim) *|* [*UnscopedClaim*](#unscopedclaim) *Defined in* [*src/types/index.ts:299*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L299) *** ### Condition Ƭ **Condition**: [*SingleClaimCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/singleclaimcondition.md) *|* [*MultiClaimCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/multiclaimcondition.md) *|* [*IdentityCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitycondition.md) *|* [*ExternalAgentCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/externalagentcondition.md) *&* [*ConditionBase*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/conditionbase.md) *Defined in* [*src/types/index.ts:412*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L412) *** ### ConfigureDividendDistributionParams Ƭ **ConfigureDividendDistributionParams**: *Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object* *Defined in* [*src/api/procedures/configureDividendDistribution.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/configureDividendDistribution.ts#L61) *** ### Ensured Ƭ **Ensured**: *Required‹Pick‹T, K››* *Defined in* [*src/types/utils/index.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L65) Pick a single property from T and ensure it is defined *** ### EnsuredV2 Ƭ **EnsuredV2**: *Required‹Pick‹T, K›› & object* *Defined in* [*src/types/utils/index.ts:67*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L67) *** ### GenericAuthorizationData Ƭ **GenericAuthorizationData**: *object* *Defined in* [*src/types/index.ts:1059*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1059) #### Type declaration: * **type**: [*Exclude*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/targettreatment.md#exclude)*‹*[*AuthorizationType*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md)*,* [*RotatePrimaryKey*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#rotateprimarykey) *|* [*JoinIdentity*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#joinidentity) *|* [*PortfolioCustody*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#portfoliocustody) *|* [*BecomeAgent*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#becomeagent) *|* [*AddRelayerPayingKey*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#addrelayerpayingkey) *|* [*RotatePrimaryKeyToSecondary*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#rotateprimarykeytosecondary)*›* * **value**: *string* *** ### GetReturnType Ƭ **GetReturnType**: [*ActiveTransferRestrictions*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/activetransferrestrictions.md)*‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›* *Defined in* [*src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:49*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts#L49) *** ### GroupPermissions Ƭ **GroupPermissions**: *Pick‹*[*Permissions*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/permissions)*, "transactions" | "transactionGroups"›* *Defined in* [*src/types/index.ts:937*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L937) Asset 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:26*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L26) Recursively traverse a type and transform its Entity properties into their human readable version (as if `.toHuman` had been called on all of them) *** ### InputCaCheckpoint Ƭ **InputCaCheckpoint**: [*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/checkpoint) *|* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule) *| Date | object | object* *Defined in* [*src/api/entities/Asset/Checkpoints/types.ts:10*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/Checkpoints/types.ts#L10) *** ### InputCondition Ƭ **InputCondition**: [*SingleClaimCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/singleclaimcondition.md) *|* [*MultiClaimCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/multiclaimcondition.md) *|* [*Modify*](#modify)*‹*[*IdentityCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitycondition.md)*, object› |* [*ExternalAgentCondition*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/externalagentcondition.md) *&* [*InputConditionBase*](#inputconditionbase) *Defined in* [*src/types/index.ts:420*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L420) *** ### InputConditionBase Ƭ **InputConditionBase**: [*Modify*](#modify)*‹*[*ConditionBase*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/conditionbase.md)*, object›* *Defined in* [*src/types/index.ts:383*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L383) *** ### InputRequirement Ƭ **InputRequirement**: [*Modify*](#modify)*‹*[*Requirement*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/requirement.md)*, object›* *Defined in* [*src/types/index.ts:446*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L446) *** ### InputTargets Ƭ **InputTargets**: [*Modify*](#modify)*‹*[*CorporateActionTargets*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/corporateactiontargets.md)*, object›* *Defined in* [*src/api/entities/CorporateActionBase/types.ts:21*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/types.ts#L21) *** ### InputTaxWithholding Ƭ **InputTaxWithholding**: [*Modify*](#modify)*‹*[*TaxWithholding*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/taxwithholding.md)*, object›* *Defined in* [*src/api/entities/CorporateActionBase/types.ts:28*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/types.ts#L28) *** ### InputTrustedClaimIssuer Ƭ **InputTrustedClaimIssuer**: [*Modify*](#modify)*‹*[*TrustedClaimIssuer*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/trustedclaimissuer.md)*, object›* *Defined in* [*src/types/index.ts:359*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L359) *** ### InstructionDetails Ƭ **InstructionDetails**: *object & object | object* *Defined in* [*src/api/entities/Instruction/types.ts:17*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Instruction/types.ts#L17) *** ### InstructionStatusResult Ƭ **InstructionStatusResult**: *object | object* *Defined in* [*src/api/entities/Instruction/types.ts:57*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Instruction/types.ts#L57) *** ### JoinIdentityAuthorizationData Ƭ **JoinIdentityAuthorizationData**: *object* *Defined in* [*src/types/index.ts:1039*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1039) #### Type declaration: * **type**: [*JoinIdentity*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#joinidentity) * **value**: [*Permissions*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/permissions) *** ### MapTxAndArgsArray Ƭ **MapTxAndArgsArray**: *object* *Defined in* [*src/utils/internal.ts:831*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/internal.ts#L831) #### Type declaration: *** ### Modify Ƭ **Modify**: *Omit‹T, keyof R› & R* *Defined in* [*src/types/utils/index.ts:55*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L55) Override T with the properties of R *** ### ModifyAllowanceParams Ƭ **ModifyAllowanceParams**: [*SetAllowanceParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setallowanceparams.md) *|* [*IncreaseAllowanceParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/increaseallowanceparams.md) *|* [*DecreaseAllowanceParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/decreaseallowanceparams.md) *& object* *Defined in* [*src/api/procedures/modifyAllowance.ts:32*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyAllowance.ts#L32) *** ### ModifyAssetParams Ƭ **ModifyAssetParams**: *object | object | object | object* *Defined in* [*src/api/procedures/modifyAsset.ts:12*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyAsset.ts#L12) *** ### ModifyCaDefaultConfigParams Ƭ **ModifyCaDefaultConfigParams**: *object | object | object* *Defined in* [*src/api/procedures/modifyCaDefaultConfig.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyCaDefaultConfig.ts#L23) *** ### ModifyClaimsParams Ƭ **ModifyClaimsParams**: [*AddClaimsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addclaimsparams.md) *|* [*EditClaimsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/editclaimsparams.md) *|* [*RevokeClaimsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/revokeclaimsparams.md) *Defined in* [*src/api/procedures/modifyClaims.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyClaims.ts#L50) *** ### ModifyComplianceRequirementParams Ƭ **ModifyComplianceRequirementParams**: *object* *Defined in* [*src/api/procedures/modifyComplianceRequirement.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyComplianceRequirement.ts#L11) #### Type declaration: * **conditions**: [*InputCondition*](#inputcondition)*\[]* * **id**: *BigNumber* *** ### ModifyOfferingTimesParams Ƭ **ModifyOfferingTimesParams**: *object | object | object* *Defined in* [*src/api/procedures/modifyOfferingTimes.ts:63*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyOfferingTimes.ts#L63) *** ### ModifyVenueParams Ƭ **ModifyVenueParams**: *object | object | object* *Defined in* [*src/api/procedures/modifyVenue.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyVenue.ts#L7) *** ### Mutable Ƭ **Mutable**: *object* *Defined in* [*src/types/utils/index.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L7) #### Type declaration: *** ### NextKey Ƭ **NextKey**: *string | BigNumber | null* *Defined in* [*src/types/index.ts:681*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L681) *** ### PaginatedQueryArgs Ƭ **PaginatedQueryArgs**: *T & object* *Defined in* [*src/types/utils/index.ts:71*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L71) *** ### PermissionsLike Ƭ **PermissionsLike**: *object & object | object* *Defined in* [*src/types/index.ts:1172*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1172) Permissions to grant to a Signer over an Identity [Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/permissions) **`note`** TxGroups in the `transactionGroups` array will be transformed into their corresponding `TxTag`s *** ### PortfolioCustodyAuthorizationData Ƭ **PortfolioCustodyAuthorizationData**: *object* *Defined in* [*src/types/index.ts:1044*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1044) #### Type declaration: * **type**: [*PortfolioCustody*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#portfoliocustody) * **value**: [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/numberedportfolio) *|* [*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/defaultportfolio) *** ### PortfolioLike Ƭ **PortfolioLike**: *string |* [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identity) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/numberedportfolio) *|* [*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/defaultportfolio) *| object* *Defined in* [*src/types/index.ts:1158*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1158) *** ### PrivateKey Ƭ **PrivateKey**: *object | object | object* *Defined in* [*src/types/index.ts:1397*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1397) URI|mnemonic|hex representation of a private key *** ### ProcedureFunc Ƭ **ProcedureFunc**: *function* *Defined in* [*src/types/utils/index.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L11) #### Type declaration: ▸ (): *Procedure‹Args, ReturnValue, Storage›* *** ### QueryArgs Ƭ **QueryArgs**: *object* *Defined in* [*src/types/utils/index.ts:76*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L76) #### Type declaration: *** ### QueryReturnType Ƭ **QueryReturnType**: *T extends AugmentedQuery‹"promise", infer Fun› ? ReturnType‹Fun› extends Observable‹infer R› ? R : never : never* *Defined in* [*src/types/utils/index.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L46) Extract the return type of a polkadot.js query function **`example`** `QueryReturnType` returns `Option` *** ### Role Ƭ **Role**: [*TickerOwnerRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/tickerownerrole.md) *|* [*CddProviderRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/cddproviderrole.md) *|* [*VenueOwnerRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/venueownerrole.md) *|* [*PortfolioCustodianRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/portfoliocustodianrole.md) *|* [*IdentityRole*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identityrole.md) *Defined in* [*src/types/index.ts:123*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L123) *** ### RotatePrimaryKeyAuthorizationData Ƭ **RotatePrimaryKeyAuthorizationData**: *object* *Defined in* [*src/types/index.ts:1030*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1030) #### Type declaration: * **type**: [*RotatePrimaryKey*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#rotateprimarykey) *** ### RotatePrimaryKeyToSecondaryData Ƭ **RotatePrimaryKeyToSecondaryData**: *object* *Defined in* [*src/types/index.ts:1034*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1034) #### Type declaration: * **type**: [*RotatePrimaryKeyToSecondary*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/authorizationtype.md#rotateprimarykeytosecondary) * **value**: [*Permissions*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/permissions) *** ### ScopedClaim Ƭ **ScopedClaim**: [*JurisdictionClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/jurisdictionclaim.md) *|* [*InvestorUniquenessClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investoruniquenessclaim.md) *|* [*AccreditedClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/accreditedclaim.md) *|* [*AffiliateClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/affiliateclaim.md) *|* [*BuyLockupClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/buylockupclaim.md) *|* [*SellLockupClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/selllockupclaim.md) *|* [*KycClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/kycclaim.md) *|* [*ExemptedClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/exemptedclaim.md) *|* [*BlockedClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/blockedclaim.md) *Defined in* [*src/types/index.ts:286*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L286) *** ### SetRestrictionsParams Ƭ **SetRestrictionsParams**: *Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›* *Defined in* [*src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:42*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts#L42) *** ### SetTransferRestrictionsParams Ƭ **SetTransferRestrictionsParams**: *object &* [*SetCountTransferRestrictionsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setcounttransferrestrictionsparams.md) *|* [*SetPercentageTransferRestrictionsParams*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/setpercentagetransferrestrictionsparams.md) *Defined in* [*src/api/procedures/setTransferRestrictions.ts:42*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/setTransferRestrictions.ts#L42) *** ### Signer Ƭ **Signer**: [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identity) *|* [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/account) *Defined in* [*src/types/index.ts:1140*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1140) *** ### SubCallback Ƭ **SubCallback**: *function* *Defined in* [*src/types/index.ts:643*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L643) #### Type declaration: ▸ (`result`: T): *void | Promise‹void›* **Parameters:** | Name | Type | | -------- | ---- | | `result` | T | *** ### TransactionArgument Ƭ **TransactionArgument**: *object &* [*PlainTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/plaintransactionargument.md) *|* [*ArrayTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/arraytransactionargument.md) *|* [*SimpleEnumTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/simpleenumtransactionargument.md) *|* [*ComplexTransactionArgument*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/complextransactionargument.md) *Defined in* [*src/types/index.ts:1129*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L1129) *** ### UnionOfProcedureFuncs Ƭ **UnionOfProcedureFuncs**: *Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never* *Defined in* [*src/types/utils/index.ts:13*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L13) *** ### UnscopedClaim Ƭ **UnscopedClaim**: [*NoDataClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/nodataclaim.md) *|* [*CddClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/cddclaim.md) *|* [*InvestorUniquenessV2Claim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investoruniquenessv2claim.md) *Defined in* [*src/types/index.ts:297*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L297) *** ### UnsubCallback Ƭ **UnsubCallback**: *function* *Defined in* [*src/types/index.ts:645*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/index.ts#L645) #### Type declaration: ▸ (): *void* *** ### WithRequired Ƭ **WithRequired**: *T & object* *Defined in* [*src/types/utils/index.ts:60*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L60) Ensure a specific property of T is defined ## Variables ### `Const` caNotExistsMessage • **caNotExistsMessage**: *"The Corporate Action doesn't exist"* = "The Corporate Action doesn't exist" *Defined in* [*src/api/procedures/removeCorporateAction.ts:33*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/removeCorporateAction.ts#L33) *** ### `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:60*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Instruction/index.ts#L60) *** ### `Const` notExistsMessage • **notExistsMessage**: *"The Portfolio doesn't exist or was removed by its owner"* = "The Portfolio doesn't exist or was removed by its owner" *Defined in* [*src/api/entities/CheckpointSchedule/index.ts:41*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CheckpointSchedule/index.ts#L41) *Defined in* [*src/api/entities/DividendDistribution/index.ts:94*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L94) *Defined in* [*src/api/entities/Portfolio/index.ts:59*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Portfolio/index.ts#L59) ## Functions ### `Const` areSameClaimIssuers ▸ **areSameClaimIssuers**(`currentClaimIssuers`: [TrustedClaimIssuer](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/trustedclaimissuer.md)\[], `claimIssuers`: ModifyAssetTrustedClaimIssuersAddSetParams\["claimIssuers"]): *boolean* *Defined in* [*src/api/procedures/modifyAssetTrustedClaimIssuers.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyAssetTrustedClaimIssuers.ts#L65) **Parameters:** | Name | Type | | --------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `currentClaimIssuers` | [TrustedClaimIssuer](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/trustedclaimissuer.md)\[] | | `claimIssuers` | ModifyAssetTrustedClaimIssuersAddSetParams\["claimIssuers"] | **Returns:** *boolean* *** ### `Const` areSameClaims ▸ **areSameClaims**(`claim`: [Claim](#claim), `__namedParameters`: object): *boolean* *Defined in* [*src/api/procedures/modifyClaims.ts:52*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyClaims.ts#L52) **Parameters:** ▪ **claim**: [*Claim*](#claim) ▪ **\_\_namedParameters**: *object* | Name | Type | | ------- | --------------------------------------------------------------------------------------------------------------------- | | `scope` | undefined \| null \| [Scope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/scope.md) | | `type` | ClaimTypeEnum | **Returns:** *boolean* *** ### `Const` areSameTargets ▸ **areSameTargets**(`targets`: [CorporateActionTargets](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/corporateactiontargets.md), `newTargets`: [InputTargets](#inputtargets)): *boolean* *Defined in* [*src/api/procedures/modifyCaDefaultConfig.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyCaDefaultConfig.ts#L45) **Parameters:** | Name | Type | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------- | | `targets` | [CorporateActionTargets](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/corporateactiontargets.md) | | `newTargets` | [InputTargets](#inputtargets) | **Returns:** *boolean* *** ### assembleBatchTransactions ▸ **assembleBatchTransactions**‹**ArgsArray**›(`txsAndArgs`: [MapTxAndArgsArray](#maptxandargsarray)‹ArgsArray›): *MapTxWithArgs‹unknown\[]\[]›* *Defined in* [*src/utils/internal.ts:854*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/internal.ts#L854) Assemble the `transactions` array that has to be passed to `addBatchTransaction` from a set of parameter arrays with their respective transaction **Type parameters:** ▪ **ArgsArray**: *unknown\[]\[]* **Parameters:** | Name | Type | | ------------ | -------------------------------------------------- | | `txsAndArgs` | [MapTxAndArgsArray](#maptxandargsarray)‹ArgsArray› | **Returns:** *MapTxWithArgs‹unknown\[]\[]›* *** ### `Const` convertArgsToRaw ▸ **convertArgsToRaw**(`claimIssuers`: ModifyAssetTrustedClaimIssuersAddSetParams\["claimIssuers"], `rawTicker`: Ticker, `context`: Context): *object* *Defined in* [*src/api/procedures/modifyAssetTrustedClaimIssuers.ts:40*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyAssetTrustedClaimIssuers.ts#L40) **Parameters:** | Name | Type | | -------------- | ----------------------------------------------------------- | | `claimIssuers` | ModifyAssetTrustedClaimIssuersAddSetParams\["claimIssuers"] | | `rawTicker` | Ticker | | `context` | Context | **Returns:** *object* * **claimIssuersToAdd**: *\[]\[]* * **inputDids**: *string\[]* *** ### createProcedureMethod ▸ **createProcedureMethod**‹**ProcedureArgs**, **ProcedureReturnValue**, **Storage**›(`args`: object, `context`: Context): [*NoArgsProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md)*‹ProcedureReturnValue, ProcedureReturnValue›* *Defined in* [*src/utils/internal.ts:404*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/internal.ts#L404) Create a method that prepares a procedure **Type parameters:** ▪ **ProcedureArgs** ▪ **ProcedureReturnValue** ▪ **Storage** **Parameters:** ▪ **args**: *object* | Name | Type | | --------------------- | -------- | | `getProcedureAndArgs` | function | | `voidArgs` | true | ▪ **context**: *Context* **Returns:** [*NoArgsProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md)*‹ProcedureReturnValue, ProcedureReturnValue›* ▸ **createProcedureMethod**‹**ProcedureArgs**, **ProcedureReturnValue**, **ReturnValue**, **Storage**›(`args`: object, `context`: Context): [*NoArgsProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md)*‹ProcedureReturnValue, ReturnValue›* *Defined in* [*src/utils/internal.ts:421*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/internal.ts#L421) **Type parameters:** ▪ **ProcedureArgs** ▪ **ProcedureReturnValue** ▪ **ReturnValue** ▪ **Storage** **Parameters:** ▪ **args**: *object* | Name | Type | | --------------------- | -------- | | `getProcedureAndArgs` | function | | `transformer` | function | | `voidArgs` | true | ▪ **context**: *Context* **Returns:** [*NoArgsProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md)*‹ProcedureReturnValue, ReturnValue›* ▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **Storage**›(`args`: object, `context`: Context): [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›* *Defined in* [*src/utils/internal.ts:440*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/internal.ts#L440) **Type parameters:** ▪ **MethodArgs**: *object* ▪ **ProcedureArgs** ▪ **ProcedureReturnValue** ▪ **Storage** **Parameters:** ▪ **args**: *object* | Name | Type | | --------------------- | -------- | | `getProcedureAndArgs` | function | ▪ **context**: *Context* **Returns:** [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›* ▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ProcedureReturnValue**, **ReturnValue**, **Storage**›(`args`: object, `context`: Context): [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ReturnValue›* *Defined in* [*src/utils/internal.ts:460*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/internal.ts#L460) **Type parameters:** ▪ **MethodArgs**: *object* ▪ **ProcedureArgs** ▪ **ProcedureReturnValue** ▪ **ReturnValue** ▪ **Storage** **Parameters:** ▪ **args**: *object* | Name | Type | | --------------------- | -------- | | `getProcedureAndArgs` | function | | `transformer` | function | ▪ **context**: *Context* **Returns:** [*ProcedureMethod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md)*‹MethodArgs, ProcedureReturnValue, ReturnValue›* *** ### `Const` findClaimsByOtherIssuers ▸ **findClaimsByOtherIssuers**(`claims`: [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimtarget.md)\[], `claimsByDid`: Record‹string, MiddlewareClaim\[]›): [*Claim*](#claim)*\[]* *Defined in* [*src/api/procedures/modifyClaims.ts:62*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyClaims.ts#L62) **Parameters:** | Name | Type | | ------------- | --------------------------------------------------------------------------------------------------------------- | | `claims` | [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimtarget.md)\[] | | `claimsByDid` | Record‹string, MiddlewareClaim\[]› | **Returns:** [*Claim*](#claim)*\[]* *** ### `Const` findPositiveBalanceIuClaims ▸ **findPositiveBalanceIuClaims**(`claims`: [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimtarget.md)\[], `context`: Context): *Promise‹*[*Claim*](#claim)*\[]›* *Defined in* [*src/api/procedures/modifyClaims.ts:78*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/procedures/modifyClaims.ts#L78) **Parameters:** | Name | Type | | --------- | --------------------------------------------------------------------------------------------------------------- | | `claims` | [ClaimTarget](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimtarget.md)\[] | | `context` | Context | **Returns:** *Promise‹*[*Claim*](#claim)*\[]›* *** ### isAccount ▸ **isAccount**(`value`: unknown): *value is Account* *Defined in* [*src/utils/typeguards.ts:70*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L70) Return whether value is an Account **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Account* *** ### isAccreditedClaim ▸ **isAccreditedClaim**(`claim`: [Claim](#claim)): *claim is AccreditedClaim* *Defined in* [*src/utils/typeguards.ts:214*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L214) Return whether Claim is an AccreditedClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is AccreditedClaim* *** ### isAffiliateClaim ▸ **isAffiliateClaim**(`claim`: [Claim](#claim)): *claim is AffiliateClaim* *Defined in* [*src/utils/typeguards.ts:221*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L221) Return whether Claim is an AffiliateClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is AffiliateClaim* *** ### isAsset ▸ **isAsset**(`value`: unknown): *value is Asset* *Defined in* [*src/utils/typeguards.ts:161*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L161) Return whether value is an Asset **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Asset* *** ### isAuthorizationRequest ▸ **isAuthorizationRequest**(`value`: unknown): *value is AuthorizationRequest* *Defined in* [*src/utils/typeguards.ts:77*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L77) Return whether value is an AuthorizationRequest **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is AuthorizationRequest* *** ### isBlockedClaim ▸ **isBlockedClaim**(`claim`: [Claim](#claim)): *claim is BlockedClaim* *Defined in* [*src/utils/typeguards.ts:270*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L270) Return whether Claim is a BlockedClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is BlockedClaim* *** ### isBuyLockupClaim ▸ **isBuyLockupClaim**(`claim`: [Claim](#claim)): *claim is BuyLockupClaim* *Defined in* [*src/utils/typeguards.ts:228*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L228) Return whether Claim is a BuyLockupClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is BuyLockupClaim* *** ### isCddClaim ▸ **isCddClaim**(`claim`: [Claim](#claim)): *claim is CddClaim* *Defined in* [*src/utils/typeguards.ts:242*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L242) Return whether Claim is a CddClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is CddClaim* *** ### isCddProviderRole ▸ **isCddProviderRole**(`role`: [Role](#role)): *role is CddProviderRole* *Defined in* [*src/utils/typeguards.ts:339*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L339) Return whether Role is CddProviderRole **Parameters:** | Name | Type | | ------ | ------------- | | `role` | [Role](#role) | **Returns:** *role is CddProviderRole* *** ### isCheckpoint ▸ **isCheckpoint**(`value`: unknown): *value is Checkpoint* *Defined in* [*src/utils/typeguards.ts:84*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L84) Return whether value is a Checkpoint **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Checkpoint* *** ### isCheckpointSchedule ▸ **isCheckpointSchedule**(`value`: unknown): *value is CheckpointSchedule* *Defined in* [*src/utils/typeguards.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L91) Return whether value is a CheckpointSchedule **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is CheckpointSchedule* *** ### isCorporateAction ▸ **isCorporateAction**(`value`: unknown): *value is CorporateAction* *Defined in* [*src/utils/typeguards.ts:98*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L98) Return whether value is a CorporateAction **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is CorporateAction* *** ### isCustomPermissionGroup ▸ **isCustomPermissionGroup**(`value`: unknown): *value is CustomPermissionGroup* *Defined in* [*src/utils/typeguards.ts:105*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L105) Return whether value is a CustomPermissionGroup **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is CustomPermissionGroup* *** ### isDefaultPortfolio ▸ **isDefaultPortfolio**(`value`: unknown): *value is DefaultPortfolio* *Defined in* [*src/utils/typeguards.ts:112*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L112) Return whether value is a DefaultPortfolio **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is DefaultPortfolio* *** ### isDefaultTrustedClaimIssuer ▸ **isDefaultTrustedClaimIssuer**(`value`: unknown): *value is DefaultTrustedClaimIssuer* *Defined in* [*src/utils/typeguards.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L119) Return whether value is a DefaultTrustedClaimIssuer **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is DefaultTrustedClaimIssuer* *** ### isDividendDistribution ▸ **isDividendDistribution**(`value`: unknown): *value is DividendDistribution* *Defined in* [*src/utils/typeguards.ts:126*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L126) Return whether value is a DividendDistribution **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is DividendDistribution* *** ### isEntity ▸ **isEntity**‹**Identifiers**, **HumanReadable**›(`value`: unknown): *value is Entity‹Identifiers, HumanReadable›* *Defined in* [*src/utils/typeguards.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L61) Return whether value is an Entity **Type parameters:** ▪ **Identifiers** ▪ **HumanReadable** **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Entity‹Identifiers, HumanReadable›* *** ### isExemptedClaim ▸ **isExemptedClaim**(`claim`: [Claim](#claim)): *claim is ExemptedClaim* *Defined in* [*src/utils/typeguards.ts:263*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L263) Return whether Claim is an ExemptedClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is ExemptedClaim* *** ### isIdentity ▸ **isIdentity**(`value`: unknown): *value is Identity* *Defined in* [*src/utils/typeguards.ts:133*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L133) Return whether value is an Identity **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Identity* *** ### isIdentityCondition ▸ **isIdentityCondition**(`condition`: [InputCondition](#inputcondition)): *condition is InputConditionBase & IdentityCondition* *Defined in* [*src/utils/typeguards.ts:316*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L316) Return whether Condition has multiple Claims **Parameters:** | Name | Type | | ----------- | --------------------------------- | | `condition` | [InputCondition](#inputcondition) | **Returns:** *condition is InputConditionBase & IdentityCondition* *** ### isIdentityRole ▸ **isIdentityRole**(`role`: [Role](#role)): *role is IdentityRole* *Defined in* [*src/utils/typeguards.ts:353*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L353) Return whether Role is IdentityRole **Parameters:** | Name | Type | | ------ | ------------- | | `role` | [Role](#role) | **Returns:** *role is IdentityRole* *** ### isInstruction ▸ **isInstruction**(`value`: unknown): *value is Instruction* *Defined in* [*src/utils/typeguards.ts:140*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L140) Return whether value is an Instruction **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Instruction* *** ### isInvestorUniquenessClaim ▸ **isInvestorUniquenessClaim**(`claim`: [Claim](#claim)): *claim is InvestorUniquenessClaim* *Defined in* [*src/utils/typeguards.ts:277*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L277) Return whether a Claim is an InvestorUniquenessClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is InvestorUniquenessClaim* *** ### isInvestorUniquenessV2Claim ▸ **isInvestorUniquenessV2Claim**(`claim`: [Claim](#claim)): *claim is InvestorUniquenessV2Claim* *Defined in* [*src/utils/typeguards.ts:291*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L291) Return whether a Claim is an InvestorUniquenessV2Claim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is InvestorUniquenessV2Claim* *** ### isJurisdictionClaim ▸ **isJurisdictionClaim**(`claim`: [Claim](#claim)): *claim is JurisdictionClaim* *Defined in* [*src/utils/typeguards.ts:256*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L256) Return whether Claim is a JurisdictionClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is JurisdictionClaim* *** ### isKnownPermissionGroup ▸ **isKnownPermissionGroup**(`value`: unknown): *value is KnownPermissionGroup* *Defined in* [*src/utils/typeguards.ts:147*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L147) Return whether value is a KnownPermissionGroup **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is KnownPermissionGroup* *** ### isKycClaim ▸ **isKycClaim**(`claim`: [Claim](#claim)): *claim is KycClaim* *Defined in* [*src/utils/typeguards.ts:249*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L249) Return whether Claim is a KycClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is KycClaim* *** ### isMultiClaimCondition ▸ **isMultiClaimCondition**(`condition`: [InputCondition](#inputcondition)): *condition is InputConditionBase & MultiClaimCondition* *Defined in* [*src/utils/typeguards.ts:307*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L307) Return whether Condition has multiple Claims **Parameters:** | Name | Type | | ----------- | --------------------------------- | | `condition` | [InputCondition](#inputcondition) | **Returns:** *condition is InputConditionBase & MultiClaimCondition* *** ### isNoDataClaim ▸ **isNoDataClaim**(`claim`: [Claim](#claim)): *claim is NoDataClaim* *Defined in* [*src/utils/typeguards.ts:284*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L284) Return whether Claim is a NoDataClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is NoDataClaim* *** ### isNumberedPortfolio ▸ **isNumberedPortfolio**(`value`: unknown): *value is NumberedPortfolio* *Defined in* [*src/utils/typeguards.ts:154*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L154) Return whether value is a NumberedPortfolio **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is NumberedPortfolio* *** ### isOffering ▸ **isOffering**(`value`: unknown): *value is Offering* *Defined in* [*src/utils/typeguards.ts:168*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L168) Return whether value is an Offering **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Offering* *** ### isPolymeshError ▸ **isPolymeshError**(`value`: unknown): *value is PolymeshError* *Defined in* [*src/utils/typeguards.ts:189*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L189) Return whether value is a PolymeshError **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is PolymeshError* *** ### isPolymeshTransaction ▸ **isPolymeshTransaction**(`value`: unknown): *value is PolymeshTransaction* *Defined in* [*src/utils/typeguards.ts:359*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L359) Return whether value is a PolymeshTransaction **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is PolymeshTransaction* *** ### isPolymeshTransactionBatch ▸ **isPolymeshTransactionBatch**(`value`: unknown): *value is PolymeshTransactionBatch* *Defined in* [*src/utils/typeguards.ts:366*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L366) Return whether value is a PolymeshTransactionBatch **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is PolymeshTransactionBatch* *** ### isPortfolioCustodianRole ▸ **isPortfolioCustodianRole**(`role`: [Role](#role)): *role is PortfolioCustodianRole* *Defined in* [*src/utils/typeguards.ts:325*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L325) Return whether Role is PortfolioCustodianRole **Parameters:** | Name | Type | | ------ | ------------- | | `role` | [Role](#role) | **Returns:** *role is PortfolioCustodianRole* *** ### isScopedClaim ▸ **isScopedClaim**(`claim`: [Claim](#claim)): *claim is ScopedClaim* *Defined in* [*src/utils/typeguards.ts:207*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L207) Return whether a Claim is a ScopedClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is ScopedClaim* *** ### isSellLockupClaim ▸ **isSellLockupClaim**(`claim`: [Claim](#claim)): *claim is SellLockupClaim* *Defined in* [*src/utils/typeguards.ts:235*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L235) Return whether Claim is a SellLockupClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is SellLockupClaim* *** ### isSingleClaimCondition ▸ **isSingleClaimCondition**(`condition`: [InputCondition](#inputcondition)): *condition is InputConditionBase & SingleClaimCondition* *Defined in* [*src/utils/typeguards.ts:298*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L298) Return whether Condition has a single Claim **Parameters:** | Name | Type | | ----------- | --------------------------------- | | `condition` | [InputCondition](#inputcondition) | **Returns:** *condition is InputConditionBase & SingleClaimCondition* *** ### isTickerOwnerRole ▸ **isTickerOwnerRole**(`role`: [Role](#role)): *role is TickerOwnerRole* *Defined in* [*src/utils/typeguards.ts:346*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L346) Return whether Role is TickerOwnerRole **Parameters:** | Name | Type | | ------ | ------------- | | `role` | [Role](#role) | **Returns:** *role is TickerOwnerRole* *** ### isTickerReservation ▸ **isTickerReservation**(`value`: unknown): *value is TickerReservation* *Defined in* [*src/utils/typeguards.ts:175*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L175) Return whether value is a TickerReservation **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is TickerReservation* *** ### isUnscopedClaim ▸ **isUnscopedClaim**(`claim`: [Claim](#claim)): *claim is UnscopedClaim* *Defined in* [*src/utils/typeguards.ts:196*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L196) Return whether a Claim is an UnscopedClaim **Parameters:** | Name | Type | | ------- | --------------- | | `claim` | [Claim](#claim) | **Returns:** *claim is UnscopedClaim* *** ### isVenue ▸ **isVenue**(`value`: unknown): *value is Venue* *Defined in* [*src/utils/typeguards.ts:182*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L182) Return whether value is a Venue **Parameters:** | Name | Type | | ------- | ------- | | `value` | unknown | **Returns:** *value is Venue* *** ### isVenueOwnerRole ▸ **isVenueOwnerRole**(`role`: [Role](#role)): *role is VenueOwnerRole* *Defined in* [*src/utils/typeguards.ts:332*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/typeguards.ts#L332) Return whether Role is VenueOwnerRole **Parameters:** | Name | Type | | ------ | ------------- | | `role` | [Role](#role) | **Returns:** *role is VenueOwnerRole* *** ### tickerToDid ▸ **tickerToDid**(`ticker`: string): *string* *Defined in* [*src/utils/conversion.ts:249*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/conversion.ts#L249) Generate an Asset'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:85*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/types/utils/index.ts#L85) 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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/txgroup.md)): *TxTag\[]* *Defined in* [*src/utils/conversion.ts:627*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/utils/conversion.ts#L627) Retrieve every Transaction Tag associated to a Transaction Group **Parameters:** | Name | Type | | ------- | ----------------------------------------------------------------------------------------------- | | `group` | [TxGroup](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/txgroup.md) | **Returns:** *TxTag\[]* ## Object literals ### `Const` defaultMessages ### ▪ **defaultMessages**: *object* *Defined in* [*src/base/PolymeshError.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/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/31a16a34/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/31a16a34/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/31a16a34/src/base/PolymeshError.ts#L6)