Polymesh SDK API Reference
alpha
alphabetav10.0.0v2.0.0v3.0.0v4.0.0v5.0.0v6.0.0v7.0.0v8.0.0v9.0.0v11.0.2v12.0.2v13.0.0v14.1.0
alpha
alphabetav10.0.0v2.0.0v3.0.0v4.0.0v5.0.0v6.0.0v7.0.0v8.0.0v9.0.0v11.0.2v12.0.2v13.0.0v14.1.0
  • README
  • modules
  • @polymathnetwork/polymesh-sdk
    • api_client_AccountManagement.AccountManagement
    • api_client_Assets.Assets
    • api_client_Claims.Claims
    • api_client_Identities.Identities
    • api_client_Network.Network
    • api_client_Polymesh.Polymesh
    • api_client_Settlements.Settlements
    • api_entities_Account.Account
    • api_entities_Asset.Asset
    • api_entities_Asset_AssetHolders.AssetHolders
    • api_entities_Asset_Checkpoints.Checkpoints
    • api_entities_Asset_Checkpoints_Schedules.Schedules
    • api_entities_Asset_Compliance.Compliance
    • api_entities_Asset_Compliance_Requirements.Requirements
    • api_entities_Asset_Compliance_TrustedClaimIssuers.TrustedClaimIssuers
    • api_entities_Asset_CorporateActions.CorporateActions
    • api_entities_Asset_CorporateActions_Distributions.Distributions
    • api_entities_Asset_Documents.Documents
    • api_entities_Asset_Issuance.Issuance
    • api_entities_Asset_Offerings.Offerings
    • api_entities_Asset_Permissions.Permissions
    • api_entities_Asset_Settlements.Settlements
    • api_entities_Asset_TransferRestrictions.TransferRestrictions
    • api_entities_Asset_TransferRestrictions_Count.Count
    • api_entities_Asset_TransferRestrictions_Percentage.Percentage
    • api_entities_Asset_TransferRestrictions_TransferRestrictionBase.TransferRestrictionBase
    • api_entities_AuthorizationRequest.AuthorizationRequest
    • api_entities_Checkpoint.Checkpoint
    • api_entities_CheckpointSchedule.CheckpointSchedule
    • api_entities_CorporateAction.CorporateAction
    • api_entities_CorporateActionBase.CorporateActionBase
    • api_entities_CustomPermissionGroup.CustomPermissionGroup
    • api_entities_DefaultPortfolio.DefaultPortfolio
    • api_entities_DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer
    • api_entities_DividendDistribution.DividendDistribution
    • api_entities_Entity.Entity
    • api_entities_Identity.Identity
    • api_entities_Identity_AssetPermissions.AssetPermissions
    • api_entities_Identity_IdentityAuthorizations.IdentityAuthorizations
    • api_entities_Identity_Portfolios.Portfolios
    • api_entities_Instruction.Instruction
    • api_entities_KnownPermissionGroup.KnownPermissionGroup
    • api_entities_NumberedPortfolio.NumberedPortfolio
    • api_entities_Offering.Offering
    • api_entities_PermissionGroup.PermissionGroup
    • api_entities_Portfolio.Portfolio
    • api_entities_Subsidy.Subsidy
    • api_entities_TickerReservation.TickerReservation
    • api_entities_Venue.Venue
    • api_entities_common_namespaces_Authorizations.Authorizations
  • enums
    • api_entities_Asset_Checkpoints_types.CaCheckpointType
    • api_entities_CorporateActionBase_types.CorporateActionKind
    • api_entities_CorporateActionBase_types.TargetTreatment
    • api_entities_Instruction_types.AffirmationStatus
    • api_entities_Instruction_types.InstructionStatus
    • api_entities_Instruction_types.InstructionType
    • api_entities_Offering_types.OfferingBalanceStatus
    • api_entities_Offering_types.OfferingSaleStatus
    • api_entities_Offering_types.OfferingTimingStatus
    • api_entities_TickerReservation_types.TickerReservationStatus
    • api_entities_Venue_types.VenueType
    • types.AuthorizationType
    • types.CalendarUnit
    • types.ClaimType
    • types.ConditionTarget
    • types.ConditionType
    • types.ErrorCode
    • types.KnownAssetType
    • types.PayingAccountType
    • types.PermissionGroupType
    • types.PermissionType
    • types.RoleType
    • types.ScopeType
    • types.SecurityIdentifierType
    • types.SignerType
    • types.TransactionArgumentType
    • types.TransactionQueueStatus
    • types.TransactionStatus
    • types.TransferError
    • types.TransferRestrictionType
    • types.TransferStatus
    • types.TxGroup
  • interfaces
    • api_entities_Account.UniqueIdentifiers
    • api_entities_Asset.UniqueIdentifiers
    • api_entities_Asset_CorporateActions_types.CorporateActionDefaultConfig
    • api_entities_Asset_types.AgentWithGroup
    • api_entities_Asset_types.AssetDetails
    • api_entities_Asset_types.IdentityBalance
    • api_entities_Asset_types.TransferBreakdown
    • api_entities_Asset_types.TransferRestrictionResult
    • api_entities_AuthorizationRequest.Params
    • api_entities_AuthorizationRequest.UniqueIdentifiers
    • api_entities_Checkpoint.UniqueIdentifiers
    • api_entities_CheckpointSchedule.Params
    • api_entities_CheckpointSchedule.UniqueIdentifiers
    • api_entities_CheckpointSchedule_types.ScheduleDetails
    • api_entities_CorporateAction.HumanReadable
    • api_entities_CorporateAction.Params
    • api_entities_CorporateAction.UniqueIdentifiers
    • api_entities_CorporateActionBase.HumanReadable
    • api_entities_CorporateActionBase.Params
    • api_entities_CorporateActionBase.UniqueIdentifiers
    • api_entities_CorporateActionBase_types.CorporateActionTargets
    • api_entities_CorporateActionBase_types.TaxWithholding
    • api_entities_CustomPermissionGroup.HumanReadable
    • api_entities_CustomPermissionGroup.UniqueIdentifiers
    • api_entities_DefaultPortfolio.UniqueIdentifiers
    • api_entities_DefaultTrustedClaimIssuer.UniqueIdentifiers
    • api_entities_DividendDistribution.DividendDistributionParams
    • api_entities_DividendDistribution_types.DistributionParticipant
    • api_entities_DividendDistribution_types.DividendDistributionDetails
    • api_entities_Identity.UniqueIdentifiers
    • api_entities_Instruction.UniqueIdentifiers
    • api_entities_Instruction_types.InstructionAffirmation
    • api_entities_Instruction_types.Leg
    • api_entities_KnownPermissionGroup.HumanReadable
    • api_entities_KnownPermissionGroup.UniqueIdentifiers
    • api_entities_NumberedPortfolio.UniqueIdentifiers
    • api_entities_Offering.UniqueIdentifiers
    • api_entities_Offering_types.Investment
    • api_entities_Offering_types.OfferingDetails
    • api_entities_Offering_types.OfferingStatus
    • api_entities_Offering_types.OfferingTier
    • api_entities_Offering_types.Tier
    • api_entities_PermissionGroup.UniqueIdentifiers
    • api_entities_Portfolio.UniqueIdentifiers
    • api_entities_Portfolio_types.HistoricSettlement
    • api_entities_Portfolio_types.PortfolioBalance
    • api_entities_Portfolio_types.SettlementLeg
    • api_entities_Subsidy.UniqueIdentifiers
    • api_entities_Subsidy_types.SubsidyData
    • api_entities_Subsidy_types.SubsidyWithAllowance
    • api_entities_TickerReservation.UniqueIdentifiers
    • api_entities_TickerReservation_types.TickerReservationDetails
    • api_entities_Venue.UniqueIdentifiers
    • api_entities_Venue_types.VenueDetails
    • api_procedures_addAssetRequirement.AddAssetRequirementParams
    • api_procedures_addInstruction.AddInstructionParams
    • api_procedures_addInstruction.AddInstructionWithVenueIdParams
    • api_procedures_addInstruction.AddInstructionsParams
    • api_procedures_addInvestorUniquenessClaim.AddInvestorUniquenessClaimParams
    • api_procedures_addTransferRestriction.Storage
    • api_procedures_claimClassicTicker.ClaimClassicTickerParams
    • api_procedures_configureDividendDistribution.ConfigureDividendDistributionParams
    • api_procedures_consumeAuthorizationRequests.ConsumeParams
    • api_procedures_consumeJoinOrRotateAuthorization.Storage
    • api_procedures_controllerTransfer.ControllerTransferParams
    • api_procedures_controllerTransfer.Storage
    • api_procedures_createAsset.CreateAssetParams
    • api_procedures_createAsset.CreateAssetWithTickerParams
    • api_procedures_createCheckpointSchedule.CreateCheckpointScheduleParams
    • api_procedures_createGroup.CreateGroupParams
    • api_procedures_createVenue.CreateVenueParams
    • api_procedures_deletePortfolio.DeletePortfolioParams
    • api_procedures_investInOffering.InvestInOfferingParams
    • api_procedures_inviteAccount.InviteAccountParams
    • api_procedures_inviteExternalAgent.InviteExternalAgentParams
    • api_procedures_issueTokens.IssueTokensParams
    • api_procedures_issueTokens.Storage
    • api_procedures_linkCaDocs.LinkCaDocsParams
    • api_procedures_modifyAllowance.DecreaseAllowanceParams
    • api_procedures_modifyAllowance.IncreaseAllowanceParams
    • api_procedures_modifyAllowance.SetAllowanceParams
    • api_procedures_modifyAssetTrustedClaimIssuers.ModifyAssetTrustedClaimIssuersAddSetParams
    • api_procedures_modifyAssetTrustedClaimIssuers.ModifyAssetTrustedClaimIssuersRemoveParams
    • api_procedures_modifyCorporateActionsAgent.ModifyCorporateActionsAgentParams
    • api_procedures_modifyInstructionAffirmation.AffirmInstructionParams
    • api_procedures_modifyInstructionAffirmation.ModifyInstructionAffirmationParams
    • api_procedures_modifyInstructionAffirmation.Storage
    • api_procedures_modifyPrimaryIssuanceAgent.ModifyPrimaryIssuanceAgentParams
    • api_procedures_modifySignerPermissions.ModifySignerPermissionsParams
    • api_procedures_moveFunds.MoveFundsParams
    • api_procedures_payDividends.PayDividendsParams
    • api_procedures_quitCustody.Storage
    • api_procedures_quitSubsidy.QuitSubsidyParams
    • api_procedures_redeemTokens.RedeemTokensParams
    • api_procedures_registerIdentity.RegisterIdentityParams
    • api_procedures_removeAssetRequirement.RemoveAssetRequirementParams
    • api_procedures_removeCheckpointSchedule.RemoveCheckpointScheduleParams
    • api_procedures_removeCorporateAction.RemoveCorporateActionParams
    • api_procedures_removeExternalAgent.RemoveExternalAgentParams
    • api_procedures_removeSecondaryAccounts.RemoveSecondaryAccountsParams
    • api_procedures_renamePortfolio.RenamePortfolioParams
    • api_procedures_reserveTicker.ReserveTickerParams
    • api_procedures_setAssetDocuments.SetAssetDocumentsParams
    • api_procedures_setAssetDocuments.Storage
    • api_procedures_setAssetRequirements.SetAssetRequirementsParams
    • api_procedures_setCustodian.SetCustodianParams
    • api_procedures_setGroupPermissions.SetGroupPermissionsParams
    • api_procedures_setPermissionGroup.SetPermissionGroupParams
    • api_procedures_setTransferRestrictions.SetCountTransferRestrictionsParams
    • api_procedures_setTransferRestrictions.SetPercentageTransferRestrictionsParams
    • api_procedures_subsidizeAccount.SubsidizeAccountParams
    • api_procedures_toggleFreezeOffering.ToggleFreezeOfferingParams
    • api_procedures_toggleFreezeSecondaryAccounts.ToggleFreezeSecondaryAccountsParams
    • api_procedures_toggleFreezeTransfers.ToggleFreezeTransfersParams
    • api_procedures_togglePauseRequirements.TogglePauseRequirementsParams
    • api_procedures_transferAssetOwnership.TransferAssetOwnershipParams
    • api_procedures_transferPolyx.TransferPolyxParams
    • api_procedures_transferTickerOwnership.TransferTickerOwnershipParams
    • api_procedures_waivePermissions.WaivePermissionsParams
    • types.AccreditedClaim
    • types.ActiveTransferRestrictions
    • types.AffiliateClaim
    • types.ArrayTransactionArgument
    • types.AssetDocument
    • types.AssetWithGroup
    • types.Balance
    • types.BlockedClaim
    • types.BuyLockupClaim
    • types.CalendarPeriod
    • types.CddClaim
    • types.CddProviderRole
    • types.CheckPermissionsResult
    • types.CheckRolesResult
    • types.CheckpointWithData
    • types.ClaimData
    • types.ClaimScope
    • types.ClaimTarget
    • types.ComplexTransactionArgument
    • types.Compliance
    • types.ComplianceRequirements
    • types.ConditionBase
    • types.ConditionCompliance
    • types.CountTransferRestriction
    • types.CountTransferRestrictionInput
    • types.DistributionPayment
    • types.DistributionWithDetails
    • types.EventIdentifier
    • types.ExemptKey
    • types.ExemptedClaim
    • types.ExternalAgentCondition
    • types.ExtrinsicData
    • types.ExtrinsicDataWithFees
    • types.Fees
    • types.FeesBreakdown
    • types.GroupedInstructions
    • types.HistoricAgentOperation
    • types.IdentityCondition
    • types.IdentityRole
    • types.IdentityWithClaims
    • types.InvestorUniquenessClaim
    • types.InvestorUniquenessV2Claim
    • types.JurisdictionClaim
    • types.KycClaim
    • types.MiddlewareConfig
    • types.MultiClaimCondition
    • types.NetworkProperties
    • types.NoArgsProcedureMethod
    • types.NoDataClaim
    • types.NoTypeClaim
    • types.OfferingWithDetails
    • types.PaginationOptions
    • types.PayingAccount
    • types.PercentageTransferRestriction
    • types.PercentageTransferRestrictionInput
    • types.PermissionGroups
    • types.PermissionedAccount
    • types.Permissions
    • types.PlainTransactionArgument
    • types.PortfolioCustodianRole
    • types.PortfolioMovement
    • types.ProcedureAuthorizationStatus
    • types.ProcedureMethod
    • types.ProcedureOpts
    • types.ProtocolFees
    • types.Requirement
    • types.RequirementCompliance
    • types.ResultSet
    • types.ScheduleWithDetails
    • types.Scope
    • types.SectionPermissions
    • types.SecurityIdentifier
    • types.SellLockupClaim
    • types.SignerValue
    • types.SimpleEnumTransactionArgument
    • types.SimplePermissions
    • types.SingleClaimCondition
    • types.ThirdPartyFees
    • types.TickerOwnerRole
    • types.TransactionPermissions
    • types.TransferRestriction
    • types.TrustedClaimIssuer
    • types.VenueOwnerRole
  • modules
    • api_client_AccountManagement
    • api_client_Assets
    • api_client_Claims
    • api_client_Identities
    • api_client_Network
    • api_client_Polymesh
    • api_client_Settlements
    • api_entities_Account
    • api_entities_Asset
    • api_entities_Asset_AssetHolders
    • api_entities_Asset_Checkpoints
    • api_entities_Asset_Checkpoints_Schedules
    • api_entities_Asset_Checkpoints_types
    • api_entities_Asset_Compliance
    • api_entities_Asset_Compliance_Requirements
    • api_entities_Asset_Compliance_TrustedClaimIssuers
    • api_entities_Asset_CorporateActions
    • api_entities_Asset_CorporateActions_Distributions
    • api_entities_Asset_CorporateActions_types
    • api_entities_Asset_Documents
    • api_entities_Asset_Issuance
    • api_entities_Asset_Offerings
    • api_entities_Asset_Permissions
    • api_entities_Asset_Settlements
    • api_entities_Asset_TransferRestrictions
    • api_entities_Asset_TransferRestrictions_Count
    • api_entities_Asset_TransferRestrictions_Percentage
    • api_entities_Asset_TransferRestrictions_TransferRestrictionBase
    • api_entities_Asset_types
    • api_entities_AuthorizationRequest
    • api_entities_Checkpoint
    • api_entities_CheckpointSchedule
    • api_entities_CheckpointSchedule_types
    • api_entities_CorporateAction
    • api_entities_CorporateActionBase
    • api_entities_CorporateActionBase_types
    • api_entities_CustomPermissionGroup
    • api_entities_DefaultPortfolio
    • api_entities_DefaultTrustedClaimIssuer
    • api_entities_DividendDistribution
    • api_entities_DividendDistribution_types
    • api_entities_Entity
    • api_entities_Identity
    • api_entities_Identity_AssetPermissions
    • api_entities_Identity_IdentityAuthorizations
    • api_entities_Identity_Portfolios
    • api_entities_Instruction
    • api_entities_Instruction_types
    • api_entities_KnownPermissionGroup
    • api_entities_Namespace
    • api_entities_NumberedPortfolio
    • api_entities_Offering
    • api_entities_Offering_types
    • api_entities_PermissionGroup
    • api_entities_Portfolio
    • api_entities_Portfolio_types
    • api_entities_Subsidy
    • api_entities_Subsidy_types
    • api_entities_TickerReservation
    • api_entities_TickerReservation_types
    • api_entities_Venue
    • api_entities_Venue_types
    • api_entities_common_namespaces_Authorizations
    • api_procedures_addAssetRequirement
    • api_procedures_addInstruction
    • api_procedures_addInvestorUniquenessClaim
    • api_procedures_addTransferRestriction
    • api_procedures_claimClassicTicker
    • api_procedures_claimDividends
    • api_procedures_closeOffering
    • api_procedures_configureDividendDistribution
    • api_procedures_consumeAddMultiSigSignerAuthorization
    • api_procedures_consumeAuthorizationRequests
    • api_procedures_consumeJoinOrRotateAuthorization
    • api_procedures_controllerTransfer
    • api_procedures_createAsset
    • api_procedures_createCheckpoint
    • api_procedures_createCheckpointSchedule
    • api_procedures_createGroup
    • api_procedures_createPortfolio
    • api_procedures_createVenue
    • api_procedures_deletePortfolio
    • api_procedures_investInOffering
    • api_procedures_inviteAccount
    • api_procedures_inviteExternalAgent
    • api_procedures_issueTokens
    • api_procedures_launchOffering
    • api_procedures_leaveIdentity
    • api_procedures_linkCaDocs
    • api_procedures_modifyAllowance
    • api_procedures_modifyAsset
    • api_procedures_modifyAssetTrustedClaimIssuers
    • api_procedures_modifyCaCheckpoint
    • api_procedures_modifyCaDefaultConfig
    • api_procedures_modifyClaims
    • api_procedures_modifyComplianceRequirement
    • api_procedures_modifyCorporateActionsAgent
    • api_procedures_modifyDistributionCheckpoint
    • api_procedures_modifyInstructionAffirmation
    • api_procedures_modifyOfferingTimes
    • api_procedures_modifyPrimaryIssuanceAgent
    • api_procedures_modifySignerPermissions
    • api_procedures_modifyVenue
    • api_procedures_moveFunds
    • api_procedures_payDividends
    • api_procedures_quitCustody
    • api_procedures_quitSubsidy
    • api_procedures_reclaimDividendDistributionFunds
    • api_procedures_redeemTokens
    • api_procedures_registerIdentity
    • api_procedures_removeAssetRequirement
    • api_procedures_removeCheckpointSchedule
    • api_procedures_removeCorporateAction
    • api_procedures_removeCorporateActionsAgent
    • api_procedures_removeExternalAgent
    • api_procedures_removePrimaryIssuanceAgent
    • api_procedures_removeSecondaryAccounts
    • api_procedures_renamePortfolio
    • api_procedures_rescheduleInstruction
    • api_procedures_reserveTicker
    • api_procedures_setAssetDocuments
    • api_procedures_setAssetRequirements
    • api_procedures_setCustodian
    • api_procedures_setGroupPermissions
    • api_procedures_setPermissionGroup
    • api_procedures_setTransferRestrictions
    • api_procedures_subsidizeAccount
    • api_procedures_toggleFreezeOffering
    • api_procedures_toggleFreezeSecondaryAccounts
    • api_procedures_toggleFreezeTransfers
    • api_procedures_togglePauseRequirements
    • api_procedures_transferAssetOwnership
    • api_procedures_transferPolyx
    • api_procedures_transferTickerOwnership
    • api_procedures_utils
    • api_procedures_waivePermissions
    • types
    • types_utils
Powered by GitBook
On this page
  • Interface: ProcedureMethod<MethodArgs, ProcedureReturnValue, ReturnValue>
  • Type parameters
  • Callable
  • Table of contents
  • Methods

Was this helpful?

  1. interfaces

types.ProcedureMethod

Previoustypes.ProcedureAuthorizationStatusNexttypes.ProcedureOpts

Last updated 2 years ago

Was this helpful?

/ / / ProcedureMethod

Interface: ProcedureMethod<MethodArgs, ProcedureReturnValue, ReturnValue>

.ProcedureMethod

Type parameters

Name
Type

MethodArgs

MethodArgs

ProcedureReturnValue

ProcedureReturnValue

ReturnValue

ProcedureReturnValue

Callable

ProcedureMethod

▸ ProcedureMethod(args, opts?): Promise<TransactionQueue<ProcedureReturnValue, ReturnValue, unknown[][]>>

Parameters

Name
Type

args

MethodArgs

opts?

Returns

Promise<TransactionQueue<ProcedureReturnValue, ReturnValue, unknown[][]>>

Defined in

Table of contents

Methods

Methods

checkAuthorization

Parameters

Name
Type

args

MethodArgs

opts?

Returns

Defined in

▸ checkAuthorization(args, opts?): Promise<>

Promise<>

@polymeshassociation/polymesh-sdk
Modules
types
types
types/index.ts:1349
ProcedureAuthorizationStatus
ProcedureAuthorizationStatus
types/index.ts:1352
checkAuthorization
ProcedureOpts
ProcedureOpts