allocate External Party allocateExternalParty : ( params : { identityProviderId : string ; multiHashSignatures ?: { format : string ; signature : string ; signedBy : string ; signingAlgorithmSpec : string ; } [] ; onboardingTransactions ?: ( | { signatures : { format : string ; signature : string ; signedBy : string ; signingAlgorithmSpec : string ; } [] ; transaction : string ; } | { transaction : string } )[] ; synchronizer : string ; } , ) => Promise < { partyId : string } >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:110 allocate Party allocateParty : ( params : { identityProviderId : string ; localMetadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; partyIdHint : string ; synchronizerId : string ; userId : string ; } , ) => Promise < { partyDetails : { identityProviderId ?: string ; isLocal : boolean ; localMetadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; party : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:122 Protectedapi Type apiType : ApiType
async Submit asyncSubmit : ( params : { actAs ?: string [] ; commandId ?: string ; commands : ( | { CreateCommand : { createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractId : string ; templateId : string ; } ; } | { CreateAndExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseByKeyCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractKey : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { AssignCommand : { reassignmentId : string ; source : string ; target : string ; } ; } | { UnassignCommand : { contractId : string ; source : string ; target : string ; } ; } )[] ; deduplicationPeriod ?: | { DeduplicationDuration : { seconds : number } } | { DeduplicationOffset : { offset : number } } | { Empty : Record < string , never > } ; disclosedContracts ?: { contractId : string ; createdEventBlob : string ; synchronizerId : string ; templateId : string ; } [] ; minLedgerTimeAbs ?: string ; minLedgerTimeRel ?: { seconds : number } ; packageIdSelectionPreference ?: string [] ; prefetchContractKeys ?: { contractKey : Record < string , | string | number | boolean | (string | number | boolean | (...)[] | { [ key : ...]: ... } | null )[] | { [ key : string ]: any } | null , > ; templateId : string ; } [] ; readAs ?: string [] ; submissionId ?: string ; synchronizerId ?: string ; userId ?: string ; workflowId ?: string ; } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:64 async Submit Reassignment asyncSubmitReassignment : ( params : { reassignmentCommands : { commandId : string ; commands : { command : | { AssignCommand : { reassignmentId : string ; source : string ; target : string ; } ; } | { UnassignCommand : { contractId : string ; source : string ; target : string ; } ; } | { Empty : Record < string , never > } ; } [] ; submissionId ?: string ; submitter : string ; userId : string ; workflowId ?: string ; } ; } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:62 Protectedauth Manager authManager : AuthenticationManager
completions completions : ( params : { beginExclusive : number ; limit ?: number ; parties : string [] ; streamIdleTimeoutMs ?: number ; userId : string ; } , ) => Promise < { completionResponse : | { Completion : { value : { actAs ?: string [] ; commandId : string ; deduplicationPeriod : | { DeduplicationDuration : { value : ... } } | { DeduplicationOffset : { value : ... } } | { Empty : Record < (...), (...)> } ; offset : number ; status ?: { code : number ; details ?: (...) | (...); message : string } ; submissionId : string ; synchronizerTime ?: { recordTime ?: (...) | (...); synchronizerId : string ; } ; traceContext ?: { traceparent ?: (...) | (...); tracestate ?: (...) | (...); } ; updateId : string ; userId : string ; } ; } ; } | { Empty : Record < string , never > } | { OffsetCheckpoint : { value : { offset : number ; synchronizerTimes ?: { recordTime ?: ...; synchronizerId : ... } [] ; } ; } ; } ; } [] , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:66 Protectedconfig config : PartialProviderConfig
create Identity Provider Config createIdentityProviderConfig : ( params : { identityProviderConfig : { audience ?: string ; identityProviderId : string ; isDeactivated : boolean ; issuer : string ; jwksUrl : string ; } ; } , ) => Promise < { identityProviderConfig : { audience ?: string ; identityProviderId : string ; isDeactivated : boolean ; issuer : string ; jwksUrl : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:88 create User createUser : ( params : { rights ?: { kind : | { CanActAs : { party : string } } | { CanReadAs : { party : string } } | { CanReadAsAnyParty : Record < string , never > } | { Empty : Record < string , never > } | { IdentityProviderAdmin : Record < string , never > } | { ParticipantAdmin : Record < string , never > } ; } [] ; user : { id : string ; isDeactivated : boolean ; metadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; primaryParty ?: string ; } ; } , ) => Promise < { user ?: { id : string ; identityProviderId : string ; isDeactivated : boolean ; metadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; primaryParty : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:148 delete Identity Provider Config deleteIdentityProviderConfig : ( params : { idpId : string } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:80 delete User deleteUser : ( params : { userId : string } ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:150 generate External Party Topology generateExternalPartyTopology : ( params : { confirmationThreshold ?: number ; localParticipantObservationOnly ?: boolean ; observingParticipantUids ?: string [] ; otherConfirmingParticipantUids ?: string [] ; partyHint : string ; publicKey : { format : string ; keyData : string ; keySpec : string } ; synchronizer : string ; } , ) => Promise < { multiHash : string ; partyId : string ; publicKeyFingerprint : string ; topologyTransactions ?: string [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:112 get Active Contracts getActiveContracts : ( params : GetActiveContractsParams , ) => Promise < { contractEntry : | { JsActiveContract : { createdEvent : { contractId : string ; contractKey : string | null ; createArgument : z.ZodRecord < z.ZodString , z.ZodType < (...) | (...) | (...) | (...) | (...) | (...), unknown , z.core.$ZodTypeInternals < (...), (...)> , > , > ; createdAt : string ; createdEventBlob : string ; implementedInterfaces ?: string [] ; interfaceViews : string [] ; nodeId : number ; observers : string [] ; offset : number ; packageName : string ; signatories : string [] ; templateId : string ; witnessParties : string [] ; } ; reassignmentCounter : number ; synchronizerId : string ; } ; } | { JsEmpty : z.ZodObject < {} , z.core.$strip > } | { JsIncompleteAssigned : { assignedEvent : { contractId : string ; nodeId : number ; offset : number ; packageName : string ; reassignmentCounter : number ; reassignmentId : string ; source : string ; submitter : string ; target : string ; templateId : string ; } ; } ; } | { JsIncompleteUnassigned : { createdEvent : { contractId : string ; contractKey : string | null ; createArgument : z.ZodRecord < z.ZodString , z.ZodType < (...) | (...) | (...) | (...) | (...) | (...), unknown , z.core.$ZodTypeInternals < (...), (...)> , > , > ; createdAt : string ; createdEventBlob : string ; implementedInterfaces ?: string [] ; interfaceViews : string [] ; nodeId : number ; observers : string [] ; offset : number ; packageName : string ; signatories : string [] ; templateId : string ; witnessParties : string [] ; } ; unassignedEvent : { contractId : string ; nodeId : number ; offset : number ; packageName : string ; reassignmentCounter : number ; reassignmentId : string ; source : string ; submitter : string ; target : string ; templateId : string ; } ; } ; } ; workflowId ?: string ; } [] , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:126 get Authenticated User getAuthenticatedUser : ( params : Record < string , never > , ) => Promise < { user : { id : string ; identityProviderId ?: string ; isDeactivated : boolean ; metadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; primaryParty ?: string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:60 get Connected Synchronizers getConnectedSynchronizers : ( params : { participantId ?: string ; party : string } , ) => Promise < { connectedSynchronizers ?: { permission : | "PARTICIPANT_PERMISSION_UNSPECIFIED" | "PARTICIPANT_PERMISSION_SUBMISSION" | "PARTICIPANT_PERMISSION_CONFIRMATION" | "PARTICIPANT_PERMISSION_OBSERVATION" ; synchronizerAlias : string ; synchronizerId : string ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:128 get Events By Contract Id getEventsByContractId : ( params : { contractId : string ; readAs ?: string [] } , ) => Promise < { archived ?: { archivedEvent : { contractId : string ; implementedInterfaces ?: string [] ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: string [] ; } ; synchronizerId : string ; } ; created ?: { createdEvent : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: { interfaceId : string ; viewStatus : { code : number ; details ?: (...) | (...); message : string } ; viewValue ?: unknown ; } [] ; nodeId : number ; observers ?: string [] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: string [] ; templateId : string ; witnessParties ?: string [] ; } ; synchronizerId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:78 get Identity Provider Config getIdentityProviderConfig : ( params : { idpId : string } , ) => Promise < { identityProviderConfig : { audience ?: string ; identityProviderId : string ; isDeactivated : boolean ; issuer : string ; jwksUrl : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:82 get Latest Pruned Offsets getLatestPrunedOffsets : ( params : Record < string , never > , ) => Promise < { allDivulgedContractsPrunedUpToInclusive : number ; participantPrunedUpToInclusive : number ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:130 get Ledger End getLedgerEnd : ( params : Record < string , never > ) => Promise < { offset : number } >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:132 get Package Status getPackageStatus : ( params : { packageId : string } , ) => Promise < { packageStatus : string } >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:104 get Participant Id getParticipantId : ( params : void | undefined , ) => Promise < { participantId : string } >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:114 get Parties getParties : ( params : { pageToken ?: string } , ) => Promise < { nextPageToken : string ; partyDetails ?: { identityProviderId : string ; isLocal : boolean ; localMetadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; party : string ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:118 get Party Details getPartyDetails : ( params : { identityProviderId ?: string ; parties ?: string [] ; party : string ; } , ) => Promise < { partyDetails ?: { identityProviderId : string ; isLocal : boolean ; localMetadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; party : string ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:116 get Transaction By Id getTransactionById : ( params : { transactionFormat : { eventFormat : { filtersByParty : Record < string , { cumulative : { identifierFilter : | { Empty : Record < (...), (...)> } | { InterfaceFilter : { value : ... } } | { TemplateFilter : { value : ... } } | { WildcardFilter : { value : ... } } ; } [] ; } , > ; filtersForAnyParty ?: { cumulative : { identifierFilter : | { Empty : Record < (...), (...)> } | { InterfaceFilter : { value : ... } } | { TemplateFilter : { value : ... } } | { WildcardFilter : { value : ... } } ; } [] ; } ; verbose ?: boolean ; } ; transactionShape : | "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS" ; } ; updateId : string ; } , ) => Promise < { transaction : { commandId : string ; effectiveAt : string ; events ?: ( | { ArchivedEvent : { contractId : string ; implementedInterfaces ?: (...)[] ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } | { CreatedEvent : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: (...)[] ; nodeId : number ; observers ?: (...)[] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: (...)[] ; templateId : string ; witnessParties ?: (...)[] ; } ; } | { ExercisedEvent : { acsDelta : boolean ; actingParties ?: (...)[] ; choice : string ; choiceArgument : unknown ; consuming : boolean ; contractId : string ; exerciseResult : unknown ; implementedInterfaces ?: (...)[] ; interfaceId ?: string ; lastDescendantNodeId : number ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } )[] ; externalTransactionHash ?: string ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:134 get Transaction By Offset getTransactionByOffset : ( params : { offset : number ; transactionFormat : { eventFormat : { filtersByParty : Record < string , { cumulative : { identifierFilter : | { Empty : Record < (...), (...)> } | { InterfaceFilter : { value : ... } } | { TemplateFilter : { value : ... } } | { WildcardFilter : { value : ... } } ; } [] ; } , > ; filtersForAnyParty ?: { cumulative : { identifierFilter : | { Empty : Record < (...), (...)> } | { InterfaceFilter : { value : ... } } | { TemplateFilter : { value : ... } } | { WildcardFilter : { value : ... } } ; } [] ; } ; verbose ?: boolean ; } ; transactionShape : | "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS" ; } ; } , ) => Promise < { transaction : { commandId : string ; effectiveAt : string ; events ?: ( | { ArchivedEvent : { contractId : string ; implementedInterfaces ?: (...)[] ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } | { CreatedEvent : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: (...)[] ; nodeId : number ; observers ?: (...)[] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: (...)[] ; templateId : string ; witnessParties ?: (...)[] ; } ; } | { ExercisedEvent : { acsDelta : boolean ; actingParties ?: (...)[] ; choice : string ; choiceArgument : unknown ; consuming : boolean ; contractId : string ; exerciseResult : unknown ; implementedInterfaces ?: (...)[] ; interfaceId ?: string ; lastDescendantNodeId : number ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } )[] ; externalTransactionHash ?: string ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:136 get Transaction Tree By Id getTransactionTreeById : ( params : { parties ?: string [] ; updateId : string ; verbose ?: boolean } , ) => Promise < { transaction : { commandId : string ; effectiveAt ?: string ; eventsById : { [ key : string ]: | { CreatedTreeEvent : { value : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: (...)[] ; nodeId : number ; observers ?: (...)[] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: (...)[] ; templateId : string ; witnessParties ?: (...)[] ; } ; } ; } | { ExercisedTreeEvent : { value : { acsDelta : boolean ; actingParties ?: (...)[] ; choice : string ; choiceArgument : unknown ; consuming : boolean ; contractId : string ; exerciseResult : unknown ; implementedInterfaces ?: (...)[] ; interfaceId ?: string ; lastDescendantNodeId : number ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } ; } ; } ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:138 get Transaction Tree By Offset getTransactionTreeByOffset : ( params : { offset : string ; parties ?: string [] ; verbose ?: boolean } , ) => Promise < { transaction : { commandId : string ; effectiveAt ?: string ; eventsById : { [ key : string ]: | { CreatedTreeEvent : { value : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: (...)[] ; nodeId : number ; observers ?: (...)[] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: (...)[] ; templateId : string ; witnessParties ?: (...)[] ; } ; } ; } | { ExercisedTreeEvent : { value : { acsDelta : boolean ; actingParties ?: (...)[] ; choice : string ; choiceArgument : unknown ; consuming : boolean ; contractId : string ; exerciseResult : unknown ; implementedInterfaces ?: (...)[] ; interfaceId ?: string ; lastDescendantNodeId : number ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } ; } ; } ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:140 get Update By Id getUpdateById : ( params : GetUpdateByIdParams , ) => Promise < { update : | { OffsetCheckpoint : { value : { offset : number ; synchronizerTimes ?: { recordTime ?: (...) | (...); synchronizerId : string ; } [] ; } ; } ; } | { Reassignment : { value : { commandId : string ; events ?: ({ JsAssignmentEvent : ... } | { JsUnassignedEvent : ... } )[] ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } ; } | { TopologyTransaction : { value : { events ?: { event : (...) | (...) | (...) | (...) } [] ; offset : number ; recordTime ?: string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; } ; } ; } | { Transaction : { value : { commandId : string ; effectiveAt : string ; events ?: ( | { ArchivedEvent : ... } | { CreatedEvent : ... } | { ExercisedEvent : ... } )[] ; externalTransactionHash ?: string ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:142 get Update By Offset getUpdateByOffset : ( params : { offset : number ; updateFormat : { includeReassignments ?: { filtersByParty : Record < string , { cumulative : { identifierFilter : | { Empty : ... } | { InterfaceFilter : ... } | { TemplateFilter : ... } | { WildcardFilter : ... } ; } [] ; } , > ; filtersForAnyParty ?: { cumulative : { identifierFilter : | { Empty : ... } | { InterfaceFilter : ... } | { TemplateFilter : ... } | { WildcardFilter : ... } ; } [] ; } ; verbose ?: boolean ; } ; includeTopologyEvents ?: { includeParticipantAuthorizationEvents ?: { parties ?: string [] } ; } ; includeTransactions ?: { eventFormat : { filtersByParty : Record < string , { cumulative : { identifierFilter : (...) | (...) | (...) | (...) } [] } , > ; filtersForAnyParty ?: { cumulative : { identifierFilter : (...) | (...) | (...) | (...) } [] ; } ; verbose ?: boolean ; } ; transactionShape : | "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS" ; } ; } ; } , ) => Promise < { update : | { OffsetCheckpoint : { value : { offset : number ; synchronizerTimes ?: { recordTime ?: (...) | (...); synchronizerId : string ; } [] ; } ; } ; } | { Reassignment : { value : { commandId : string ; events ?: ({ JsAssignmentEvent : ... } | { JsUnassignedEvent : ... } )[] ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } ; } | { TopologyTransaction : { value : { events ?: { event : (...) | (...) | (...) | (...) } [] ; offset : number ; recordTime ?: string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; } ; } ; } | { Transaction : { value : { commandId : string ; effectiveAt : string ; events ?: ( | { ArchivedEvent : ... } | { CreatedEvent : ... } | { ExercisedEvent : ... } )[] ; externalTransactionHash ?: string ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:144 get User getUser : ( params : { userId : string } , ) => Promise < { user ?: { id : string ; identityProviderId : string ; isDeactivated : boolean ; metadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; primaryParty : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:152 get Version getVersion : () => Promise < { features ?: { experimental : { commandInspectionService : { supported : boolean } ; staticTime : { supported : boolean } ; } ; offsetCheckpoint : { maxOffsetCheckpointEmissionDelay : { nanos : number ; seconds : number } ; } ; partyManagement : { maxPartiesPageSize : number } ; userManagement : { maxRightsPerUser : number ; maxUsersPageSize : number ; supported : boolean ; } ; } ; version : string ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:166 grant User Rights grantUserRights : ( params : { rights ?: { kind : | { CanActAs : { value : { party : string } } } | { CanReadAs : { value : { party : string } } } | { CanReadAsAnyParty : { value : Record < string , never > } } | { CanExecuteAs : { value : { party : string } } } | { CanExecuteAsAnyParty : { value : Record < string , never > } } | { Empty : { value : Record < string , never > } } | { IdentityProviderAdmin : { value : Record < string , never > } } | { ParticipantAdmin : { value : Record < string , never > } } ; } [] ; userId : string ; } , ) => Promise < { newlyGrantedRights ?: { kind : | { CanActAs : { value : { party : string } } } | { CanExecuteAs : { value : { party : string } } } | { CanExecuteAsAnyParty : { value : Record < string , never > } } | { CanReadAs : { value : { party : string } } } | { CanReadAsAnyParty : { value : Record < string , never > } } | { Empty : Record < string , never > } | { IdentityProviderAdmin : { value : Record < string , never > } } | { ParticipantAdmin : { value : Record < string , never > } } ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:154 Protectedhttp Client httpClient : HttpClient
interactive Submission Allocate Party interactiveSubmissionAllocateParty : ( params : { displayName ?: string ; isLocal ?: boolean ; partyIdHint ?: string ; } , ) => Promise < { party : { displayName ?: string ; isLocal : boolean ; party : string } } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:90 interactive Submission Create User interactiveSubmissionCreateUser : ( params : { rights ?: { kind : | { CanActAs : { party : string } } | { CanReadAs : { party : string } } | { CanReadAsAnyParty : Record < string , never > } | { Empty : Record < string , never > } | { IdentityProviderAdmin : Record < string , never > } | { ParticipantAdmin : Record < string , never > } ; } [] ; user : { id : string ; identityProviderId ?: string ; isDeactivated : boolean ; metadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; primaryParty ?: string ; } ; } , ) => Promise < { user : { id : string ; identityProviderId ?: string ; isDeactivated : boolean ; metadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; primaryParty ?: string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:92 interactive Submission Execute interactiveSubmissionExecute : ( params : { deduplicationPeriod ?: | { Empty : Record < string , never > } | { DeduplicationDuration : { value : { duration : string } } } | { DeduplicationOffset : { value : { offset : string } } } ; hashingSchemeVersion : string ; partySignatures : { signatures : { party : string ; signatures : { format : string ; signature : string ; signedBy : string ; signingAlgorithmSpec : string ; } [] ; } [] ; } ; preparedTransaction : string ; submissionId : string ; userId : string ; } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:94 interactive Submission Get Preferred Packages interactiveSubmissionGetPreferredPackages : ( params : { packageVettingRequirements : { packageName : string ; parties : string [] } [] ; synchronizerId ?: string ; vettingValidAt ?: string ; } , ) => Promise < { packageReferences : { packageId : string ; packageName : string ; packageVersion : string ; } [] ; synchronizerId : string ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:98 interactive Submission Get Preferred Package Version interactiveSubmissionGetPreferredPackageVersion : ( params : { packageName : string ; parties ?: string [] ; synchronizerId ?: string ; vettingValidAt ?: string ; } , ) => Promise < { packagePreference ?: { packageReference : { packageId : string ; packageName : string ; packageVersion : string ; } ; synchronizerId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:96 interactive Submission Prepare interactiveSubmissionPrepare : ( params : { actAs : string [] ; commandId : string ; commands : ( | { CreateCommand : { createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractId : string ; templateId : string ; } ; } | { CreateAndExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseByKeyCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractKey : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } )[] ; disclosedContracts ?: { contractId : string ; createdEventBlob ?: string ; metadata ?: Record < string , | string | number | boolean | (string | number | boolean | (...)[] | { [ key : ...]: ... } | null )[] | { [ key : string ]: any } | null , > ; synchronizerId : string ; templateId : string ; } [] ; packageIdSelectionPreference ?: { packageId ?: string ; packageName ?: string ; } [] ; readAs : string [] ; synchronizerId : string ; userId : string ; verboseHashing ?: boolean ; } , ) => Promise < { costEstimation ?: { confirmationRequestTrafficCostEstimation : number ; confirmationResponseTrafficCostEstimation : number ; estimationTimestamp ?: string ; totalTrafficCostEstimation : number ; } ; hashingDetails ?: string ; hashingSchemeVersion ?: | "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2" ; preparedTransaction ?: string ; preparedTransactionHash : string ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:100 interactive Submission Upload Dar interactiveSubmissionUploadDar : ( params : { darFile : Buffer < ArrayBufferLike > } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:102 list Identity Provider Configs listIdentityProviderConfigs : ( params : Record < string , never > , ) => Promise < { identityProviderConfigs : { audience ?: string ; identityProviderId : string ; isDeactivated : boolean ; issuer : string ; jwksUrl : string ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:84 list Packages listPackages : () => Promise < { packageIds : string [] } >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:106 list Parties listParties : ( params : { pageToken ?: string } , ) => Promise < { nextPageToken : string ; partyDetails ?: { identityProviderId : string ; isLocal : boolean ; localMetadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; party : string ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:120 list User Rights listUserRights : ( params : { userId : string } , ) => Promise < { rights ?: { kind : | { CanActAs : { value : { party : string } } } | { CanExecuteAs : { value : { party : string } } } | { CanExecuteAsAnyParty : { value : Record < string , never > } } | { CanReadAs : { value : { party : string } } } | { CanReadAsAnyParty : { value : Record < string , never > } } | { Empty : Record < string , never > } | { IdentityProviderAdmin : { value : Record < string , never > } } | { ParticipantAdmin : { value : Record < string , never > } } ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:156 list Users listUsers : ( params : { pageSize ?: number ; pageToken ?: string } , ) => Promise < { nextPageToken : string ; users ?: { id : string ; identityProviderId : string ; isDeactivated : boolean ; metadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; primaryParty : string ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:158 revoke User Rights revokeUserRights : ( params : { rights ?: { kind : | { CanActAs : { value : { party : string } } } | { CanReadAs : { value : { party : string } } } | { CanReadAsAnyParty : { value : Record < string , never > } } | { CanExecuteAs : { value : { party : string } } } | { CanExecuteAsAnyParty : { value : Record < string , never > } } | { Empty : { value : Record < string , never > } } | { IdentityProviderAdmin : { value : Record < string , never > } } | { ParticipantAdmin : { value : Record < string , never > } } ; } [] ; userId : string ; } , ) => Promise < { newlyRevokedRights ?: { kind : | { CanActAs : { value : { party : string } } } | { CanExecuteAs : { value : { party : string } } } | { CanExecuteAsAnyParty : { value : Record < string , never > } } | { CanReadAs : { value : { party : string } } } | { CanReadAsAnyParty : { value : Record < string , never > } } | { Empty : Record < string , never > } | { IdentityProviderAdmin : { value : Record < string , never > } } | { ParticipantAdmin : { value : Record < string , never > } } ; } [] ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:160 submit And Wait submitAndWait : ( params : { actAs ?: string [] ; commandId ?: string ; commands : ( | { CreateCommand : { createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractId : string ; templateId : string ; } ; } | { CreateAndExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseByKeyCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractKey : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { AssignCommand : { reassignmentId : string ; source : string ; target : string ; } ; } | { UnassignCommand : { contractId : string ; source : string ; target : string ; } ; } )[] ; deduplicationPeriod ?: | { DeduplicationDuration : { seconds : number } } | { DeduplicationOffset : { offset : number } } | { Empty : Record < string , never > } ; disclosedContracts ?: { contractId : string ; createdEventBlob : string ; synchronizerId : string ; templateId : string ; } [] ; minLedgerTimeAbs ?: string ; minLedgerTimeRel ?: { seconds : number } ; packageIdSelectionPreference ?: string [] ; prefetchContractKeys ?: { contractKey : Record < string , | string | number | boolean | (string | number | boolean | (...)[] | { [ key : ...]: ... } | null )[] | { [ key : string ]: any } | null , > ; templateId : string ; } [] ; readAs ?: string [] ; submissionId ?: string ; synchronizerId ?: string ; userId ?: string ; workflowId ?: string ; } , ) => Promise < { completionOffset : number ; updateId : string } >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:74 submit And Wait For Reassignment submitAndWaitForReassignment : ( params : { eventFormat ?: { filtersByParty : Record < string , { cumulative : { identifierFilter : | { Empty : Record < (...), (...)> } | { InterfaceFilter : { value : ... } } | { TemplateFilter : { value : ... } } | { WildcardFilter : { value : ... } } ; } [] ; } , > ; filtersForAnyParty ?: { cumulative : { identifierFilter : | { Empty : Record < (...), (...)> } | { InterfaceFilter : { value : ... } } | { TemplateFilter : { value : ... } } | { WildcardFilter : { value : ... } } ; } [] ; } ; verbose ?: boolean ; } ; reassignmentCommands : { commandId : string ; commands : { command : | { AssignCommand : { reassignmentId : string ; source : string ; target : string ; } ; } | { UnassignCommand : { contractId : string ; source : string ; target : string ; } ; } | { Empty : Record < string , never > } ; } [] ; submissionId ?: string ; submitter : string ; userId ?: string ; workflowId ?: string ; } ; } , ) => Promise < { reassignment : { commandId ?: string ; events : ( | { JsAssignmentEvent : { createdEvent : { contractId : string ; contractKey : string | null ; createArgument : Record < string , (...) | (...) | (...) | (...) | (...) | (...), > ; createdAt : string ; createdEventBlob : string ; implementedInterfaces ?: (...)[] ; interfaceViews : string [] ; nodeId : number ; observers : string [] ; offset : number ; packageName : string ; signatories : string [] ; templateId : string ; witnessParties : string [] ; } ; reassignmentCounter : number ; reassignmentId : string ; source : string ; submitter : string ; target : string ; } ; } | { JsUnassignedEvent : { value : { contractId : string ; nodeId : number ; offset : number ; packageName : string ; reassignmentCounter : number ; reassignmentId : string ; source : string ; submitter : string ; target : string ; templateId : string ; } ; } ; } )[] ; offset : number ; recordTime : string ; traceContext ?: { metadata ?: Record < string , string > ; parentSpanId ?: string ; spanId ?: string ; traceId ?: string ; } ; updateId : string ; workflowId ?: string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:68 submit And Wait For Transaction submitAndWaitForTransaction : ( params : { actAs ?: string [] ; commandId ?: string ; commands : ( | { CreateCommand : { createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractId : string ; templateId : string ; } ; } | { CreateAndExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseByKeyCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractKey : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { AssignCommand : { reassignmentId : string ; source : string ; target : string ; } ; } | { UnassignCommand : { contractId : string ; source : string ; target : string ; } ; } )[] ; deduplicationPeriod ?: | { DeduplicationDuration : { seconds : number } } | { DeduplicationOffset : { offset : number } } | { Empty : Record < string , never > } ; disclosedContracts ?: { contractId : string ; createdEventBlob : string ; synchronizerId : string ; templateId : string ; } [] ; minLedgerTimeAbs ?: string ; minLedgerTimeRel ?: { seconds : number } ; packageIdSelectionPreference ?: string [] ; prefetchContractKeys ?: { contractKey : Record < string , | string | number | boolean | (string | number | boolean | (...)[] | { [ key : ...]: ... } | null )[] | { [ key : string ]: any } | null , > ; templateId : string ; } [] ; readAs ?: string [] ; submissionId ?: string ; synchronizerId ?: string ; transactionFormat ?: { eventFormat : { filtersByParty : Record < string , { cumulative : { identifierFilter : | { Empty : ... } | { InterfaceFilter : ... } | { TemplateFilter : ... } | { WildcardFilter : ... } ; } [] ; } , > ; filtersForAnyParty ?: { cumulative : { identifierFilter : | { Empty : ... } | { InterfaceFilter : ... } | { TemplateFilter : ... } | { WildcardFilter : ... } ; } [] ; } ; verbose ?: boolean ; } ; transactionShape : | "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS" ; } ; userId ?: string ; workflowId ?: string ; } , ) => Promise < { transaction : { commandId : string ; effectiveAt : string ; events ?: ( | { ArchivedEvent : { contractId : string ; implementedInterfaces ?: (...)[] ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } | { CreatedEvent : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: (...)[] ; nodeId : number ; observers ?: (...)[] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: (...)[] ; templateId : string ; witnessParties ?: (...)[] ; } ; } | { ExercisedEvent : { acsDelta : boolean ; actingParties ?: (...)[] ; choice : string ; choiceArgument : unknown ; consuming : boolean ; contractId : string ; exerciseResult : unknown ; implementedInterfaces ?: (...)[] ; interfaceId ?: string ; lastDescendantNodeId : number ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } )[] ; externalTransactionHash ?: string ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:72 submit And Wait For Transaction Tree submitAndWaitForTransactionTree : ( params : { actAs ?: string [] ; commandId ?: string ; commands : ( | { CreateCommand : { createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractId : string ; templateId : string ; } ; } | { CreateAndExerciseCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; createArguments : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { ExerciseByKeyCommand : { choice : string ; choiceArgument : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; contractKey : Record < string , | string | number | boolean | ((...) | (...) | (...) | (...) | (...) | (...))[] | { [ key : string ]: any } | null , > ; templateId : string ; } ; } | { AssignCommand : { reassignmentId : string ; source : string ; target : string ; } ; } | { UnassignCommand : { contractId : string ; source : string ; target : string ; } ; } )[] ; deduplicationPeriod ?: | { DeduplicationDuration : { seconds : number } } | { DeduplicationOffset : { offset : number } } | { Empty : Record < string , never > } ; disclosedContracts ?: { contractId : string ; createdEventBlob : string ; synchronizerId : string ; templateId : string ; } [] ; minLedgerTimeAbs ?: string ; minLedgerTimeRel ?: { seconds : number } ; packageIdSelectionPreference ?: string [] ; prefetchContractKeys ?: { contractKey : Record < string , | string | number | boolean | (string | number | boolean | (...)[] | { [ key : ...]: ... } | null )[] | { [ key : string ]: any } | null , > ; templateId : string ; } [] ; readAs ?: string [] ; submissionId ?: string ; synchronizerId ?: string ; userId ?: string ; workflowId ?: string ; } , ) => Promise < { transactionTree : { commandId : string ; effectiveAt ?: string ; eventsById : { [ key : string ]: | { CreatedTreeEvent : { value : { acsDelta : boolean ; contractId : string ; contractKey ?: unknown ; createArgument ?: unknown ; createdAt : string ; createdEventBlob : string ; interfaceViews ?: (...)[] ; nodeId : number ; observers ?: (...)[] ; offset : number ; packageName : string ; representativePackageId : string ; signatories ?: (...)[] ; templateId : string ; witnessParties ?: (...)[] ; } ; } ; } | { ExercisedTreeEvent : { value : { acsDelta : boolean ; actingParties ?: (...)[] ; choice : string ; choiceArgument : unknown ; consuming : boolean ; contractId : string ; exerciseResult : unknown ; implementedInterfaces ?: (...)[] ; interfaceId ?: string ; lastDescendantNodeId : number ; nodeId : number ; offset : number ; packageName : string ; templateId : string ; witnessParties ?: (...)[] ; } ; } ; } ; } ; offset : number ; recordTime : string ; synchronizerId : string ; traceContext ?: { traceparent ?: string ; tracestate ?: string } ; updateId : string ; workflowId : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:70 subscribe To Completions subscribeToCompletions : ( params : { beginExclusive ?: number ; parties : string [] ; userId ?: string } , handlers : WebSocketHandlers < CompletionsWsMessage > , ) => Promise < WebSocketSubscription >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:76 subscribe To Updates subscribeToUpdates : ( params : SubscribeToUpdatesParams ) => Promise < void >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:146 update Identity Provider Config updateIdentityProviderConfig : ( params : { identityProviderConfig : { audience ?: string ; identityProviderId : string ; isDeactivated : boolean ; issuer : string ; jwksUrl : string ; } ; updateMask : { paths : string [] } ; } , ) => Promise < { identityProviderConfig : { audience ?: string ; identityProviderId : string ; isDeactivated : boolean ; issuer : string ; jwksUrl : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:86 update Party Details updatePartyDetails : ( params : { party : string ; partyDetails : { identityProviderId ?: string ; isLocal : boolean ; localMetadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; party : string ; } ; updateMask : { paths : string [] } ; } , ) => Promise < { partyDetails ?: { identityProviderId : string ; isLocal : boolean ; localMetadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; party : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:124 update User updateUser : ( params : { updateMask : { paths : string [] } ; user : { id : string ; isDeactivated : boolean ; metadata ?: { annotations : Record < string , string > ; resourceVersion : string ; } ; primaryParty ?: string ; } ; userId : string ; } , ) => Promise < { user ?: { id : string ; identityProviderId : string ; isDeactivated : boolean ; metadata ?: { annotations : { [ key : string ]: string } ; resourceVersion : string ; } ; primaryParty : string ; } ; } , >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:164 update User Identity Provider updateUserIdentityProvider : ( params : { sourceIdentityProviderId : string ; targetIdentityProviderId : string ; userId : string ; } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:162 upload Dar File uploadDarFile : ( params : { filePath : string ; submissionId ?: string } , ) => Promise < Record < string , never > >
Defined in node_modules/@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts:108
Client for interacting with Canton's LedgerJsonApi