-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.types
- AccountBalance
- AccountIdentityRelation
- AccountKeyType
- AccountTypeInfo
- AffirmationStatus
- AgentWithGroup
- AnyJson
- Asset
- AssetDetails
- AssetDocument
- AssetWithGroup
- Balance
- BaseHistoricAssetTransaction
- CaCheckpointType
- CheckpointScheduleParams
- CollectionKey
- CorporateActionDefaultConfig
- CorporateActionKind
- CorporateActionParams
- CorporateActionTargets
- DistributionParticipant
- DividendDistributionDetails
- DividendDistributionParams
- FungibleLeg
- GlobalMetadataKey
- GroupedInstructions
- GroupedInvolvedInstructions
- HeldNfts
- HistoricAgentOperation
- HistoricAssetTransaction
- HistoricInstruction
- HistoricNftTransaction
- HistoricPolyxTransaction
- HistoricSettlement
- IdentityBalance
- IdentityHeldNfts
- InputCaCheckpoint
- InputTargets
- InputTaxWithholding
- InstructionAffirmation
- InstructionDetails
- InstructionEndCondition
- InstructionStatus
- InstructionStatusResult
- InstructionType
- InstructionsByStatus
- Investment
- KnownAssetType
- KnownNftType
- Leg
- MediatorAffirmation
- MetadataDetails
- MetadataKeyId
- MetadataLockStatus
- MetadataSpec
- MetadataType
- MetadataValue
- MetadataValueDetails
- MetadataWithValue
- MultiSigDetails
- MultiSigProposalAction
- MultiSigProposalDetails
- MultiSigProposalVote
- MultiSigSigners
- NftLeg
- NftMetadata
- OffChainAffirmation
- OffChainLeg
- OfferingBalanceStatus
- OfferingDetails
- OfferingSaleStatus
- OfferingStatus
- OfferingTier
- OfferingTimingStatus
- PortfolioBalance
- PortfolioCollection
- ProposalStatus
- ScheduleDetails
- SecurityIdentifier
- SecurityIdentifierType
- SettlementLeg
- SubsidyData
- SubsidyWithAllowance
- TargetTreatment
- TaxWithholding
- TickerReservationDetails
- TickerReservationStatus
- Tier
- TransferBreakdown
- TransferError
- TransferRestrictionResult
- TransferStatus
- UniqueIdentifiers
- VenueDetails
- VenueFilteringDetails
- VenueType
- AuthorizationType
- ClaimType
- ConditionTarget
- ConditionType
- PermissionGroupType
- PermissionType
- ScopeType
- SignerType
- StatType
- AccreditedClaim
- ActiveTransferRestrictions
- AddCountStatInput
- AffiliateClaim
- BlockedClaim
- BuyLockupClaim
- CddClaim
- CheckPermissionsResult
- CheckRolesResult
- CheckpointWithData
- ClaimCountTransferRestriction
- ClaimData
- ClaimPercentageTransferRestriction
- ClaimScope
- ClaimTarget
- Compliance
- ComplianceRequirements
- ConditionBase
- ConditionCompliance
- CountTransferRestriction
- CustomClaim
- DistributionPayment
- DistributionWithDetails
- ExemptedClaim
- ExternalAgentCondition
- FungiblePortfolioMovement
- IdentityCondition
- IdentityWithClaims
- JurisdictionClaim
- KycClaim
- MultiClaimCondition
- OfferingWithDetails
- PaginationOptions
- PercentageTransferRestriction
- PermissionGroups
- PermissionedAccount
- Permissions
- Requirement
- RequirementCompliance
- ResultSet
- ScheduleWithDetails
- Scope
- SectionPermissions
- SellLockupClaim
- SignerValue
- SimplePermissions
- SingleClaimCondition
- StatAccreditedClaimInput
- StatAffiliateClaimInput
- StatClaimIssuer
- StatJurisdictionClaimInput
- TransactionPermissions
- TrustedClaimIssuer
- Account
- ActiveStats
- AddRelayerPayingKeyAuthorizationData
- AttestPrimaryKeyRotationAuthorizationData
- Authorization
- AuthorizationRequest
- BecomeAgentAuthorizationData
- Checkpoint
- CheckpointSchedule
- ChildIdentity
- Claim
- ClaimCountStatInput
- Condition
- CorporateAction
- CustomPermissionGroup
- DefaultPortfolio
- DefaultTrustedClaimIssuer
- DividendDistribution
- FungibleAsset
- GenericAuthorizationData
- GroupPermissions
- Identity
- InputCondition
- InputConditionBase
- InputRequirement
- InputStatClaim
- InputStatType
- InputTrustedClaimIssuer
- Instruction
- JoinIdentityAuthorizationData
- KnownPermissionGroup
- MetadataEntry
- MultiSig
- MultiSigProposal
- NextKey
- Nft
- NftCollection
- NonFungiblePortfolioMovement
- NumberedPortfolio
- Offering
- PermissionsLike
- PortfolioCustodyAuthorizationData
- PortfolioLike
- PortfolioMovement
- RotatePrimaryKeyAuthorizationData
- RotatePrimaryKeyToSecondaryData
- ScopedClaim
- Signer
- StatClaimType
- SubCallback
- Subsidy
- TickerReservation
- UnscopedClaim
- UnsubCallback
- Venue
Re-exports AccountBalance
Re-exports AccountIdentityRelation
Re-exports AccountKeyType
Re-exports AccountTypeInfo
Re-exports AffirmationStatus
Re-exports AgentWithGroup
Re-exports AnyJson
Re-exports Asset
Re-exports AssetDetails
Re-exports AssetDocument
Re-exports AssetWithGroup
Re-exports Balance
Re-exports BaseHistoricAssetTransaction
Re-exports CaCheckpointType
Re-exports CheckpointScheduleParams
Re-exports CollectionKey
Re-exports CorporateActionDefaultConfig
Re-exports CorporateActionKind
Renames and re-exports Params
Re-exports CorporateActionTargets
Re-exports DistributionParticipant
Re-exports DividendDistributionDetails
Re-exports DividendDistributionParams
Re-exports FungibleLeg
Re-exports GlobalMetadataKey
Re-exports GroupedInstructions
Re-exports GroupedInvolvedInstructions
Re-exports HeldNfts
Re-exports HistoricAgentOperation
Re-exports HistoricAssetTransaction
Re-exports HistoricInstruction
Re-exports HistoricNftTransaction
Re-exports HistoricPolyxTransaction
Re-exports HistoricSettlement
Re-exports IdentityBalance
Re-exports IdentityHeldNfts
Re-exports InputCaCheckpoint
Re-exports InputTargets
Re-exports InputTaxWithholding
Re-exports InstructionAffirmation
Re-exports InstructionDetails
Re-exports InstructionEndCondition
Re-exports InstructionStatus
Re-exports InstructionStatusResult
Re-exports InstructionType
Re-exports InstructionsByStatus
Re-exports Investment
Re-exports KnownAssetType
Re-exports KnownNftType
Re-exports Leg
Re-exports MediatorAffirmation
Re-exports MetadataDetails
Re-exports MetadataKeyId
Re-exports MetadataLockStatus
Re-exports MetadataSpec
Re-exports MetadataType
Re-exports MetadataValue
Re-exports MetadataValueDetails
Re-exports MetadataWithValue
Re-exports MultiSigDetails
Re-exports MultiSigProposalAction
Re-exports MultiSigProposalDetails
Re-exports MultiSigProposalVote
Re-exports MultiSigSigners
Re-exports NftLeg
Re-exports NftMetadata
Re-exports OffChainAffirmation
Re-exports OffChainLeg
Re-exports OfferingBalanceStatus
Re-exports OfferingDetails
Re-exports OfferingSaleStatus
Re-exports OfferingStatus
Re-exports OfferingTier
Re-exports OfferingTimingStatus
Re-exports PortfolioBalance
Re-exports PortfolioCollection
Re-exports ProposalStatus
Re-exports ScheduleDetails
Re-exports SecurityIdentifier
Re-exports SecurityIdentifierType
Re-exports SettlementLeg
Re-exports SubsidyData
Re-exports SubsidyWithAllowance
Re-exports TargetTreatment
Re-exports TaxWithholding
Re-exports TickerReservationDetails
Re-exports TickerReservationStatus
Re-exports Tier
Re-exports TransferBreakdown
Re-exports TransferError
Re-exports TransferRestrictionResult
Re-exports TransferStatus
Re-exports UniqueIdentifiers
Re-exports VenueDetails
Re-exports VenueFilteringDetails
Re-exports VenueType
Ƭ Account: Account
Ƭ ActiveStats: Object
| Name | Type |
|---|---|
claims? |
{ claimType: ClaimType ; issuer: Identity }[] |
isSet |
boolean |
Ƭ AddRelayerPayingKeyAuthorizationData: Object
| Name | Type |
|---|---|
type |
AddRelayerPayingKey |
value |
SubsidyData |
Ƭ AttestPrimaryKeyRotationAuthorizationData: Object
| Name | Type |
|---|---|
type |
AttestPrimaryKeyRotation |
value |
Identity |
Ƭ Authorization: AttestPrimaryKeyRotationAuthorizationData | RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData
Authorization request data corresponding to type
Ƭ AuthorizationRequest: AuthorizationRequest
Ƭ BecomeAgentAuthorizationData: Object
| Name | Type |
|---|---|
type |
BecomeAgent |
value |
KnownPermissionGroup | CustomPermissionGroup
|
Ƭ Checkpoint: Checkpoint
Ƭ CheckpointSchedule: CheckpointSchedule
Ƭ ChildIdentity: ChildIdentity
Ƭ Claim: ScopedClaim | UnscopedClaim
Ƭ ClaimCountStatInput: { claimType: Accredited ; issuer: Identity ; value: { accredited: BigNumber ; nonAccredited: BigNumber } } | { claimType: Affiliate ; issuer: Identity ; value: { affiliate: BigNumber ; nonAffiliate: BigNumber } } | { claimType: Jurisdiction ; issuer: Identity ; value: { count: BigNumber ; countryCode: CountryCode }[] }
Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase
Ƭ CorporateAction: CorporateAction
Ƭ CustomPermissionGroup: CustomPermissionGroup
Ƭ DefaultPortfolio: DefaultPortfolio
Ƭ DefaultTrustedClaimIssuer: DefaultTrustedClaimIssuer
Ƭ DividendDistribution: DividendDistribution
Ƭ FungibleAsset: FungibleAsset
Ƭ GenericAuthorizationData: Object
| Name | Type |
|---|---|
type |
Exclude<AuthorizationType, RotatePrimaryKey | JoinIdentity | PortfolioCustody | BecomeAgent | AddRelayerPayingKey | RotatePrimaryKeyToSecondary | AttestPrimaryKeyRotation> |
value |
string |
Ƭ GroupPermissions: Pick<Permissions, "transactions" | "transactionGroups">
Asset permissions shared by agents in a group
Ƭ Identity: Identity
Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify<IdentityCondition, { identity: string | Identity }> | ExternalAgentCondition & InputConditionBase
Ƭ InputConditionBase: Modify<ConditionBase, { trustedClaimIssuers?: InputTrustedClaimIssuer[] }>
Ƭ InputRequirement: Modify<Requirement, { conditions: InputCondition[] }>
Ƭ InputStatClaim: StatJurisdictionClaimInput | StatAccreditedClaimInput | StatAffiliateClaimInput
Ƭ InputStatType: { type: Count | Balance } | { claimIssuer: StatClaimIssuer ; type: ScopedCount | ScopedBalance }
Ƭ InputTrustedClaimIssuer: Modify<TrustedClaimIssuer, { identity: string | Identity }>
Ƭ Instruction: Instruction
Ƭ JoinIdentityAuthorizationData: Object
| Name | Type |
|---|---|
type |
JoinIdentity |
value |
Permissions |
Ƭ KnownPermissionGroup: KnownPermissionGroup
Ƭ MetadataEntry: MetadataEntry
Ƭ MultiSig: MultiSig
Ƭ MultiSigProposal: MultiSigProposal
Ƭ NextKey: string | BigNumber | null
Ƭ Nft: Nft
Ƭ NftCollection: NftCollection
Ƭ NonFungiblePortfolioMovement: Object
| Name | Type | Description |
|---|---|---|
asset |
NftCollection | string
|
- |
memo? |
string |
identifier string to help differentiate transfers |
nfts |
(Nft | BigNumber)[] |
- |
Ƭ NumberedPortfolio: NumberedPortfolio
Ƭ Offering: Offering
Ƭ PermissionsLike: { assets?: SectionPermissions<string | FungibleAsset> | null ; portfolios?: SectionPermissions<PortfolioLike> | null } & { transactions?: TransactionPermissions | null } | { transactionGroups?: TxGroup[] }
Permissions to grant to a Signer over an Identity
Note
TxGroups in the transactionGroups array will be transformed into their corresponding TxTags
Ƭ PortfolioCustodyAuthorizationData: Object
| Name | Type |
|---|---|
type |
PortfolioCustody |
value |
NumberedPortfolio | DefaultPortfolio
|
Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | { id: BigNumber ; identity: string | Identity }
Ƭ PortfolioMovement: FungiblePortfolioMovement | NonFungiblePortfolioMovement
Ƭ RotatePrimaryKeyAuthorizationData: Object
| Name | Type |
|---|---|
type |
RotatePrimaryKey |
Ƭ RotatePrimaryKeyToSecondaryData: Object
| Name | Type |
|---|---|
type |
RotatePrimaryKeyToSecondary |
value |
Permissions |
Ƭ ScopedClaim: JurisdictionClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim | CustomClaim
Ƭ StatClaimType: Accredited | Affiliate | Jurisdiction
Ƭ SubCallback<T>: (result: T) => void | Promise<void>
| Name |
|---|
T |
▸ (result): void | Promise<void>
| Name | Type |
|---|---|
result |
T |
void | Promise<void>
Ƭ Subsidy: Subsidy
Ƭ TickerReservation: TickerReservation
Ƭ UnscopedClaim: CddClaim
Ƭ UnsubCallback: () => void
▸ (): void
void
Ƭ Venue: Venue
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types