Skip to main content
Version: 22.0.x

Module: Procedures Types

Enumerations

Interfaces

Type Aliases

AddAssetStatParams

Ƭ AddAssetStatParams: { ticker: string } & AddCountStatParams | AddPercentageStatParams | AddClaimCountStatParams | AddClaimPercentageStatParams

Defined in

api/procedures/types.ts:112


AddClaimCountStatParams

Ƭ AddClaimCountStatParams: ClaimCountStatInput & { type: ScopedCount }

Defined in

api/procedures/types.ts:104


AddClaimCountTransferRestrictionParams

Ƭ AddClaimCountTransferRestrictionParams: ClaimCountTransferRestrictionInput & { type: ClaimCount }

Defined in

api/procedures/types.ts:200


AddClaimPercentageStatParams

Ƭ AddClaimPercentageStatParams: StatClaimIssuer & { type: ScopedBalance }

Defined in

api/procedures/types.ts:108


AddClaimPercentageTransferRestrictionParams

Ƭ AddClaimPercentageTransferRestrictionParams: ClaimPercentageTransferRestrictionInput & { type: ClaimPercentage }

Defined in

api/procedures/types.ts:204


AddCountStatParams

Ƭ AddCountStatParams: AddCountStatInput & { type: Count }

Defined in

api/procedures/types.ts:96


AddCountTransferRestrictionParams

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & { type: Count }

Defined in

api/procedures/types.ts:192


AddInstructionParams

Ƭ AddInstructionParams: { legs: { amount: BigNumber ; asset: string | Asset ; from: PortfolioLike ; to: PortfolioLike }[] ; memo?: string ; tradeDate?: Date ; valueDate?: Date } & { endBlock?: BigNumber } | { endAfterBlock?: BigNumber }

Defined in

api/procedures/types.ts:443


AddInstructionWithVenueIdParams

Ƭ AddInstructionWithVenueIdParams: AddInstructionParams & { venueId: BigNumber }

Defined in

api/procedures/types.ts:487


AddPercentageStatParams

Ƭ AddPercentageStatParams: Object

Type declaration

NameType
typeBalance

Defined in

api/procedures/types.ts:100


AddPercentageTransferRestrictionParams

Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & { type: Percentage }

Defined in

api/procedures/types.ts:196


AddRestrictionParams

Ƭ AddRestrictionParams<T>: Omit<T extends Count ? AddCountTransferRestrictionParams : T extends Percentage ? AddPercentageTransferRestrictionParams : T extends ClaimCount ? AddClaimCountTransferRestrictionParams : AddClaimPercentageTransferRestrictionParams, "type">

Type parameters

Name
T

Defined in

api/procedures/types.ts:57


AffirmOrWithdrawInstructionParams

Ƭ AffirmOrWithdrawInstructionParams: Object

Type declaration

NameTypeDescription
portfolios?PortfolioLike[](optional) Portfolios that the signer controls and wants to affirm the instruction or withdraw affirmation Note if empty, all the legs containing any custodied Portfolios of the signer will be affirmed/affirmation will be withdrawn, based on the operation.

Defined in

api/procedures/types.ts:508


ExecuteManualInstructionParams

Ƭ ExecuteManualInstructionParams: InstructionIdParams & { skipAffirmationCheck?: boolean }

Defined in

api/procedures/types.ts:529


GetTransferRestrictionReturnType

Ƭ GetTransferRestrictionReturnType<T>: ActiveTransferRestrictions<T extends Count ? CountTransferRestriction : T extends Percentage ? PercentageTransferRestriction : T extends ClaimCount ? ClaimCountTransferRestriction : ClaimPercentageTransferRestriction>

Type parameters

Name
T

Defined in

api/procedures/types.ts:79


ModifyAssetParams

Ƭ ModifyAssetParams: { fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name: string } | { fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible: true ; name?: string } | { fundingRound: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name?: string } | { fundingRound?: string ; identifiers: SecurityIdentifier[] ; makeDivisible?: true ; name?: string }

Defined in

api/procedures/types.ts:552


ModifyCaDefaultConfigParams

Ƭ ModifyCaDefaultConfigParams: { defaultTaxWithholding: BigNumber ; targets?: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets?: InputTargets ; taxWithholdings: InputTaxWithholding[] }

Defined in

api/procedures/types.ts:691


ModifyClaimsParams

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

Defined in

api/procedures/types.ts:360


ModifyComplianceRequirementParams

Ƭ ModifyComplianceRequirementParams: Object

Type declaration

NameTypeDescription
conditionsInputCondition[]array of conditions to replace the existing array of conditions for the requirement (identified by id). Conditions within a requirement are AND between them. This means that in order for a transfer to comply with this requirement, it must fulfill ALL conditions
idBigNumberID of the Compliance Requirement

Defined in

api/procedures/types.ts:640


ModifyInstructionAffirmationParams

Ƭ ModifyInstructionAffirmationParams: InstructionIdParams & { operation: Affirm | Withdraw } & AffirmOrWithdrawInstructionParams | { operation: Reject } & RejectInstructionParams

Defined in

api/procedures/types.ts:517


ModifyOfferingTimesParams

Ƭ ModifyOfferingTimesParams: { end: Date | null ; start?: Date } | { end?: Date | null ; start: Date } | { end: Date | null ; start: Date }

Defined in

api/procedures/types.ts:914


ModifyVenueParams

Ƭ ModifyVenueParams: { description?: string ; type: VenueType } | { description: string ; type?: VenueType } | { description: string ; type: VenueType }

Defined in

api/procedures/types.ts:862


RegisterMetadataParams

Ƭ RegisterMetadataParams: { name: string ; specs: MetadataSpec } | { details?: MetadataValueDetails ; name: string ; specs: MetadataSpec ; value: string }

Defined in

api/procedures/types.ts:1033


RejectInstructionParams

Ƭ RejectInstructionParams: Object

Type declaration

NameTypeDescription
portfolio?PortfolioLike(optional) Portfolio that the signer controls and wants to reject the instruction

Defined in

api/procedures/types.ts:501


RemoveAssetStatParams

Ƭ RemoveAssetStatParams: { ticker: string } & RemoveCountStatParams | RemoveBalanceStatParams | RemoveScopedCountParams | RemoveScopedBalanceParams

Defined in

api/procedures/types.ts:89


RemoveBalanceStatParams

Ƭ RemoveBalanceStatParams: Object

Type declaration

NameType
typeBalance

Defined in

api/procedures/types.ts:123


RemoveCountStatParams

Ƭ RemoveCountStatParams: Object

Type declaration

NameType
typeCount

Defined in

api/procedures/types.ts:119


RemoveScopedBalanceParams

Ƭ RemoveScopedBalanceParams: StatClaimIssuer & { type: ScopedBalance }

Defined in

api/procedures/types.ts:131


RemoveScopedCountParams

Ƭ RemoveScopedCountParams: StatClaimIssuer & { type: ScopedCount }

Defined in

api/procedures/types.ts:127


SetAssetStatParams

Ƭ SetAssetStatParams<T>: Omit<T extends Count ? AddCountStatParams : T extends Percentage ? AddPercentageStatParams : T extends ClaimCount ? AddClaimCountStatParams : AddClaimPercentageStatParams, "type">

Type parameters

Name
T

Defined in

api/procedures/types.ts:135


SetMetadataParams

Ƭ SetMetadataParams: { details?: MetadataValueDetails ; value: string } | { details: MetadataValueDetails }

Defined in

api/procedures/types.ts:1029


SetRestrictionsParams

Ƭ SetRestrictionsParams<T>: Omit<T extends Count ? SetCountTransferRestrictionsParams : T extends Percentage ? SetPercentageTransferRestrictionsParams : T extends ClaimCount ? SetClaimCountTransferRestrictionsParams : SetClaimPercentageTransferRestrictionsParams, "type">

Type parameters

Name
T

Defined in

api/procedures/types.ts:68


SetVenueFilteringParams

Ƭ SetVenueFilteringParams: Object

Type declaration

NameType
allowedVenues?BigNumber[]
disallowedVenues?BigNumber[]
enabled?boolean

Defined in

api/procedures/types.ts:1045