@c7-digital/ledger 0.0.2

package/lib-lite/src/generated/async-api.d.ts

@@ -0,0 +1,1665 @@
+import { LedgerString, PartyIdString, UserIdString, NameString, PackageIdString } from "../valueTypes.js";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export type paths = Record<string, never>;
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** JsCantonError */
+        JsCantonError: {
+            code: string;
+            cause: string;
+            correlationId?: string;
+            traceId?: string;
+            context: components["schemas"]["Map_String"];
+            resources?: components["schemas"]["Tuple2_String_String"][];
+            /** Format: int32 */
+            errorCategory: number;
+            /** Format: int32 */
+            grpcCodeValue?: number;
+            retryInfo?: string;
+            definiteAnswer?: boolean;
+        };
+        /** Map_String */
+        Map_String: {
+            [key: string]: string;
+        };
+        /** Tuple2_String_String */
+        Tuple2_String_String: [
+            string,
+            string
+        ];
+        /** CompletionStreamRequest */
+        CompletionStreamRequest: {
+            /**
+             * @description Only completions of commands submitted with the same user_id will be visible in the stream.
+             *     Must be a valid UserIdString (as described in ``value.proto``).
+             *     Required unless authentication is used with a user token.
+             *     In that case, the token's user-id will be used for the request's user_id.
+             */
+            userId: UserIdString;
+            /**
+             * @description Non-empty list of parties whose data should be included.
+             *     The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.
+             *     Must be a valid PartyIdString (as described in ``value.proto``).
+             *     Required
+             */
+            parties?: PartyIdString[];
+            /**
+             * Format: int64
+             * @description This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.
+             *     If not set the ledger uses the ledger begin offset instead.
+             *     If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset).
+             *     If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.
+             */
+            beginExclusive: number;
+        };
+        /** Either_JsCantonError_CompletionStreamResponse */
+        Either_JsCantonError_CompletionStreamResponse: components["schemas"]["CompletionStreamResponse"] | components["schemas"]["JsCantonError"];
+        /** Map_K_V */
+        Map_K_V: {
+            [key: string]: string;
+        };
+        /** CompletionStreamResponse */
+        CompletionStreamResponse: {
+            completionResponse: components["schemas"]["CompletionResponse"];
+        };
+        /** CompletionResponse */
+        CompletionResponse: {
+            Completion: components["schemas"]["Completion"];
+        } | {
+            Empty: components["schemas"]["Empty1"];
+        } | {
+            OffsetCheckpoint: components["schemas"]["OffsetCheckpoint"];
+        };
+        /**
+         * Completion
+         * @description A completion represents the status of a submitted command on the ledger: it can be successful or failed.
+         */
+        Completion: {
+            value: components["schemas"]["Completion1"];
+        };
+        /**
+         * Completion
+         * @description A completion represents the status of a submitted command on the ledger: it can be successful or failed.
+         */
+        Completion1: {
+            /**
+             * @description The ID of the succeeded or failed command.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            commandId: LedgerString;
+            /**
+             * @description Identifies the exact type of the error.
+             *     It uses the same format of conveying error details as it is used for the RPC responses of the APIs.
+             *     Optional
+             */
+            status?: components["schemas"]["JsStatus"];
+            /**
+             * @description The update_id of the transaction or reassignment that resulted from the command with command_id.
+             *     Only set for successfully executed commands.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             */
+            updateId: LedgerString;
+            /**
+             * @description The user-id that was used for the submission, as described in ``commands.proto``.
+             *     Must be a valid UserIdString (as described in ``value.proto``).
+             *     Optional for historic completions where this data is not available.
+             */
+            userId: UserIdString;
+            /**
+             * @description The set of parties on whose behalf the commands were executed.
+             *     Contains the ``act_as`` parties from ``commands.proto``
+             *     filtered to the requesting parties in CompletionStreamRequest.
+             *     The order of the parties need not be the same as in the submission.
+             *     Each element must be a valid PartyIdString (as described in ``value.proto``).
+             *     Optional for historic completions where this data is not available.
+             */
+            actAs?: string[];
+            /**
+             * @description The submission ID this completion refers to, as described in ``commands.proto``.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            submissionId: LedgerString;
+            deduplicationPeriod: components["schemas"]["DeduplicationPeriod"];
+            /**
+             * @description Optional; ledger API trace context
+             *
+             *     The trace context transported in this message corresponds to the trace context supplied
+             *     by the client application in a HTTP2 header of the original command submission.
+             *     We typically use a header to transfer this type of information. Here we use message
+             *     body, because it is used in gRPC streams which do not support per message headers.
+             *     This field will be populated with the trace context contained in the original submission.
+             *     If that was not provided, a unique ledger-api-server generated trace context will be used
+             *     instead.
+             */
+            traceContext?: components["schemas"]["TraceContext"];
+            /**
+             * Format: int64
+             * @description May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.
+             *     Required, must be a valid absolute offset (positive integer).
+             */
+            offset: number;
+            /**
+             * @description The synchronizer along with its record time.
+             *     The synchronizer id provided, in case of
+             *
+             *     - successful/failed transactions: identifies the synchronizer of the transaction
+             *     - for successful/failed unassign commands: identifies the source synchronizer
+             *     - for successful/failed assign commands: identifies the target synchronizer
+             *
+             *     Required
+             */
+            synchronizerTime?: components["schemas"]["SynchronizerTime"];
+        };
+        /** JsStatus */
+        JsStatus: {
+            /** Format: int32 */
+            code: number;
+            message: string;
+            details?: components["schemas"]["ProtoAny"][];
+        };
+        /** ProtoAny */
+        ProtoAny: {
+            typeUrl: string;
+            value: string;
+            unknownFields: components["schemas"]["UnknownFieldSet"];
+            valueDecoded?: string;
+        };
+        /** UnknownFieldSet */
+        UnknownFieldSet: {
+            fields: components["schemas"]["Map_Int_Field"];
+        };
+        /** Map_Int_Field */
+        Map_Int_Field: {
+            [key: string]: components["schemas"]["Field"];
+        };
+        /** Field */
+        Field: {
+            varint?: number[];
+            fixed64?: number[];
+            fixed32?: number[];
+            lengthDelimited?: string[];
+        };
+        /** DeduplicationPeriod */
+        DeduplicationPeriod: {
+            DeduplicationDuration: components["schemas"]["DeduplicationDuration"];
+        } | {
+            DeduplicationOffset: components["schemas"]["DeduplicationOffset"];
+        } | {
+            Empty: components["schemas"]["Empty"];
+        };
+        /** DeduplicationDuration */
+        DeduplicationDuration: {
+            value: components["schemas"]["Duration"];
+        };
+        /** Duration */
+        Duration: {
+            /** Format: int64 */
+            seconds: number;
+            /** Format: int32 */
+            nanos: number;
+            /** @description This field is automatically added as part of protobuf to json mapping */
+            unknownFields?: components["schemas"]["UnknownFieldSet"];
+        };
+        /** DeduplicationOffset */
+        DeduplicationOffset: {
+            /** Format: int64 */
+            value: number;
+        };
+        /** Empty */
+        Empty: Record<string, never>;
+        /** TraceContext */
+        TraceContext: {
+            /** @description https://www.w3.org/TR/trace-context/ */
+            traceparent?: string;
+            tracestate?: string;
+        };
+        /** SynchronizerTime */
+        SynchronizerTime: {
+            /**
+             * @description The id of the synchronizer.
+             *     Required
+             */
+            synchronizerId: string;
+            /**
+             * @description All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.
+             *     Required
+             */
+            recordTime?: string;
+        };
+        /** Empty */
+        Empty1: Record<string, never>;
+        /**
+         * OffsetCheckpoint
+         * @description OffsetCheckpoints may be used to:
+         *
+         *     - detect time out of commands.
+         *     - provide an offset which can be used to restart consumption.
+         */
+        OffsetCheckpoint: {
+            value: components["schemas"]["OffsetCheckpoint1"];
+        };
+        /**
+         * OffsetCheckpoint
+         * @description OffsetCheckpoints may be used to:
+         *
+         *     - detect time out of commands.
+         *     - provide an offset which can be used to restart consumption.
+         */
+        OffsetCheckpoint1: {
+            /**
+             * Format: int64
+             * @description The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``.
+             *     Required, must be a valid absolute offset (positive integer).
+             */
+            offset: number;
+            synchronizerTimes?: components["schemas"]["SynchronizerTime"][];
+        };
+        /**
+         * GetActiveContractsRequest
+         * @description If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,
+         *     the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED".
+         *     Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party
+         *     migration is not concerned with incomplete (un)assignments.
+         */
+        GetActiveContractsRequest: {
+            /**
+             * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+             *     Templates to include in the served snapshot, per party.
+             *     Optional, if specified event_format must be unset, if not specified event_format must be set.
+             */
+            filter?: components["schemas"]["TransactionFilter"];
+            /**
+             * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+             *     If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
+             *     In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
+             *     Optional, if specified event_format must be unset.
+             */
+            verbose: boolean;
+            /**
+             * Format: int64
+             * @description The offset at which the snapshot of the active contracts will be computed.
+             *     Must be no greater than the current ledger end offset.
+             *     Must be greater than or equal to the last pruning offset.
+             *     Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).
+             *     If zero, the empty set will be returned.
+             */
+            activeAtOffset: number;
+            /**
+             * @description Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
+             *     TRANSACTION_SHAPE_ACS_DELTA.
+             *     Optional for backwards compatibility, defaults to an EventFormat where:
+             *
+             *     - filters_by_party is the filter.filters_by_party from this request
+             *     - filters_for_any_party is the filter.filters_for_any_party from this request
+             *     - verbose is the verbose field from this request
+             */
+            eventFormat?: components["schemas"]["EventFormat"];
+        };
+        /**
+         * TransactionFilter
+         * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+         *     Used both for filtering create and archive events as well as for filtering transaction trees.
+         */
+        TransactionFilter: {
+            /**
+             * @description Each key must be a valid PartyIdString (as described in ``value.proto``).
+             *     The interpretation of the filter depends on the transaction-shape being filtered:
+             *
+             *     1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
+             *        wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.
+             *        If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will
+             *        not be used for template/interface filtering.
+             *     2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
+             *        the listed parties and match the per-party filter.
+             *     3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
+             *        stakeholders include at least one of the listed parties and match the per-party filter.
+             */
+            filtersByParty: components["schemas"]["Map_Filters"];
+            /**
+             * @description Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
+             *     with the per-party filter as described above.
+             */
+            filtersForAnyParty?: components["schemas"]["Filters"];
+        };
+        /** Map_Filters */
+        Map_Filters: {
+            [key: string]: components["schemas"]["Filters"];
+        };
+        /**
+         * Filters
+         * @description The union of a set of template filters, interface filters, or a wildcard.
+         */
+        Filters: {
+            /**
+             * @description Every filter in the cumulative list expands the scope of the resulting stream. Each interface,
+             *     template or wildcard filter means additional events that will match the query.
+             *     The impact of include_interface_view and include_created_event_blob fields in the filters will
+             *     also be accumulated.
+             *     A template or an interface SHOULD NOT appear twice in the accumulative field.
+             *     A wildcard filter SHOULD NOT be defined more than once in the accumulative field.
+             *     Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with
+             *     include_created_event_blob unset is used.
+             */
+            cumulative?: components["schemas"]["CumulativeFilter"][];
+        };
+        /**
+         * CumulativeFilter
+         * @description A filter that matches all contracts that are either an instance of one of
+         *     the ``template_filters`` or that match one of the ``interface_filters``.
+         */
+        CumulativeFilter: {
+            identifierFilter: components["schemas"]["IdentifierFilter"];
+        };
+        /** IdentifierFilter */
+        IdentifierFilter: {
+            Empty: components["schemas"]["Empty2"];
+        } | {
+            InterfaceFilter: components["schemas"]["InterfaceFilter"];
+        } | {
+            TemplateFilter: components["schemas"]["TemplateFilter"];
+        } | {
+            WildcardFilter: components["schemas"]["WildcardFilter"];
+        };
+        /** Empty */
+        Empty2: Record<string, never>;
+        /**
+         * InterfaceFilter
+         * @description This filter matches contracts that implement a specific interface.
+         */
+        InterfaceFilter: {
+            value: components["schemas"]["InterfaceFilter1"];
+        };
+        /**
+         * InterfaceFilter
+         * @description This filter matches contracts that implement a specific interface.
+         */
+        InterfaceFilter1: {
+            /**
+             * @description The interface that a matching contract must implement.
+             *     The ``interface_id`` needs to be valid: corresponding interface should be defined in
+             *     one of the available packages at the time of the query.
+             *     Both package-name and package-id reference formats for the identifier are supported.
+             *     Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
+             *
+             *     Required
+             */
+            interfaceId?: string;
+            /**
+             * @description Whether to include the interface view on the contract in the returned ``CreatedEvent``.
+             *     Use this to access contract data in a uniform manner in your API client.
+             *     Optional
+             */
+            includeInterfaceView: boolean;
+            /**
+             * @description Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
+             *     Use this to access the contract create event payload in your API client
+             *     for submitting it as a disclosed contract with future commands.
+             *     Optional
+             */
+            includeCreatedEventBlob: boolean;
+        };
+        /**
+         * TemplateFilter
+         * @description This filter matches contracts of a specific template.
+         */
+        TemplateFilter: {
+            value: components["schemas"]["TemplateFilter1"];
+        };
+        /**
+         * TemplateFilter
+         * @description This filter matches contracts of a specific template.
+         */
+        TemplateFilter1: {
+            /**
+             * @description A template for which the payload should be included in the response.
+             *     The ``template_id`` needs to be valid: corresponding template should be defined in
+             *     one of the available packages at the time of the query.
+             *     Both package-name and package-id reference formats for the identifier are supported.
+             *     Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
+             *
+             *     Required
+             */
+            templateId?: string;
+            /**
+             * @description Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
+             *     Use this to access the contract event payload in your API client
+             *     for submitting it as a disclosed contract with future commands.
+             *     Optional
+             */
+            includeCreatedEventBlob: boolean;
+        };
+        /**
+         * WildcardFilter
+         * @description This filter matches all templates.
+         */
+        WildcardFilter: {
+            value: components["schemas"]["WildcardFilter1"];
+        };
+        /**
+         * WildcardFilter
+         * @description This filter matches all templates.
+         */
+        WildcardFilter1: {
+            /**
+             * @description Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
+             *     Use this to access the contract create event payload in your API client
+             *     for submitting it as a disclosed contract with future commands.
+             *     Optional
+             */
+            includeCreatedEventBlob: boolean;
+        };
+        /**
+         * EventFormat
+         * @description A format for events which defines both which events should be included
+         *     and what data should be computed and included for them.
+         *
+         *     Note that some of the filtering behavior depends on the `TransactionShape`,
+         *     which is expected to be specified alongside usages of `EventFormat`.
+         */
+        EventFormat: {
+            /**
+             * @description Each key must be a valid PartyIdString (as described in ``value.proto``).
+             *     The interpretation of the filter depends on the transaction-shape being filtered:
+             *
+             *     1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
+             *        the listed parties and match the per-party filter.
+             *     2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
+             *        stakeholders include at least one of the listed parties and match the per-party filter.
+             *
+             *     Optional
+             */
+            filtersByParty: components["schemas"]["Map_Filters"];
+            /**
+             * @description Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
+             *     with the per-party filter as described above.
+             *     Optional
+             */
+            filtersForAnyParty?: components["schemas"]["Filters"];
+            /**
+             * @description If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
+             *     In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
+             *     Optional
+             */
+            verbose: boolean;
+        };
+        /** Either_JsCantonError_JsGetActiveContractsResponse */
+        Either_JsCantonError_JsGetActiveContractsResponse: components["schemas"]["JsCantonError"] | components["schemas"]["JsGetActiveContractsResponse"];
+        /** JsGetActiveContractsResponse */
+        JsGetActiveContractsResponse: {
+            /**
+             * @description The workflow ID used in command submission which corresponds to the contract_entry. Only set if
+             *     the ``workflow_id`` for the command was set.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            workflowId: LedgerString;
+            contractEntry: components["schemas"]["JsContractEntry"];
+        };
+        /** JsContractEntry */
+        JsContractEntry: {
+            JsActiveContract: components["schemas"]["JsActiveContract"];
+        } | {
+            JsEmpty: components["schemas"]["JsEmpty"];
+        } | {
+            JsIncompleteAssigned: components["schemas"]["JsIncompleteAssigned"];
+        } | {
+            JsIncompleteUnassigned: components["schemas"]["JsIncompleteUnassigned"];
+        };
+        /** JsActiveContract */
+        JsActiveContract: {
+            /**
+             * @description Required
+             *     The event as it appeared in the context of its last update (i.e. daml transaction or
+             *     reassignment). In particular, the last offset, node_id pair is preserved.
+             *     The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer.
+             *     The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
+             *     for lookups.
+             */
+            createdEvent: components["schemas"]["CreatedEvent"];
+            /**
+             * @description A valid synchronizer id
+             *     Required
+             */
+            synchronizerId: string;
+            /**
+             * Format: int64
+             * @description Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
+             *     with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
+             *     equals zero.
+             *     This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is
+             *     before the active_at_offset.
+             *     Required
+             */
+            reassignmentCounter: number;
+        };
+        /**
+         * CreatedEvent
+         * @description Records that a contract has been created, and choices may now be exercised on it.
+         */
+        CreatedEvent: {
+            /**
+             * Format: int64
+             * @description The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent.
+             *     Offsets are managed by the participant nodes.
+             *     Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
+             *     Required, it is a valid absolute offset (positive integer)
+             */
+            offset: number;
+            /**
+             * Format: int32
+             * @description The position of this event in the originating transaction or reassignment.
+             *     The origin has contextual meaning, please see description at messages that include a CreatedEvent.
+             *     Node IDs are not necessarily equal across participants,
+             *     as these may see different projections/parts of transactions.
+             *     Required, must be valid node ID (non-negative integer)
+             */
+            nodeId: number;
+            /**
+             * @description The ID of the created contract.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            contractId: LedgerString;
+            /**
+             * @description The template of the created contract.
+             *     The identifier uses the package-id reference format.
+             *
+             *     Required
+             */
+            templateId: PackageIdString;
+            /**
+             * @description The key of the created contract.
+             *     This will be set if and only if ``template_id`` defines a contract key.
+             *     Optional
+             */
+            contractKey?: unknown;
+            createArgument?: unknown;
+            /**
+             * @description Opaque representation of contract create event payload intended for forwarding
+             *     to an API server as a contract disclosed as part of a command
+             *     submission.
+             *     Optional
+             */
+            createdEventBlob: string;
+            /**
+             * @description Interface views specified in the transaction filter.
+             *     Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with
+             *
+             *     - its party in the ``witness_parties`` of this event,
+             *     - and which is implemented by the template of this event,
+             *     - and which has ``include_interface_view`` set.
+             *
+             *     Optional
+             */
+            interfaceViews?: components["schemas"]["JsInterfaceView"][];
+            /**
+             * @description The parties that are notified of this event. When a ``CreatedEvent``
+             *     is returned as part of a transaction tree or ledger-effects transaction, this will include all
+             *     the parties specified in the ``TransactionFilter`` that are witnesses  of the event
+             *     (the stakeholders of the contract and all informees of all the ancestors
+             *     of this create action that this participant knows about).
+             *     If served as part of a ACS delta transaction those will
+             *     be limited to all parties specified in the ``TransactionFilter`` that
+             *     are stakeholders of the contract (i.e. either signatories or observers).
+             *     If the ``CreatedEvent`` is returned as part of an AssignedEvent,
+             *     ActiveContract or IncompleteUnassigned (so the event is related to
+             *     an assignment or unassignment): this will include all parties of the
+             *     ``TransactionFilter`` that are stakeholders of the contract.
+             *
+             *     The behavior of reading create events visible to parties not hosted
+             *     on the participant node serving the Ledger API is undefined. Concretely,
+             *     there is neither a guarantee that the participant node will serve all their
+             *     create events on the ACS stream, nor is there a guarantee that matching archive
+             *     events are delivered for such create events.
+             *
+             *     For most clients this is not a problem, as they only read events for parties
+             *     that are hosted on the participant node. If you need to read events
+             *     for parties that may not be hosted at all times on the participant node,
+             *     subscribe to the ``TopologyEvent``s for that party by setting a corresponding
+             *     ``UpdateFormat``.  Using these events, query the ACS as-of an offset where the
+             *     party is hosted on the participant node, and ignore create events at offsets
+             *     where the party is not hosted on the participant node.
+             *     Required
+             */
+            witnessParties?: string[];
+            /**
+             * @description The signatories for this contract as specified by the template.
+             *     Required
+             */
+            signatories?: string[];
+            /**
+             * @description The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
+             *     This field never contains parties that are signatories.
+             *     Required
+             */
+            observers?: string[];
+            /**
+             * @description Ledger effective time of the transaction that created the contract.
+             *     Required
+             */
+            createdAt: string;
+            /**
+             * @description The package name of the created contract.
+             *     Required
+             */
+            packageName: string;
+            /**
+             * @description A package-id present in the participant package store that typechecks the contract's argument.
+             *     This may differ from the package-id of the template used to create the contract.
+             *     For contracts created before Canton 3.4, this field matches the contract's creation package-id.
+             *
+             *     NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice.
+             *
+             *     Required
+             */
+            representativePackageId: string;
+            /**
+             * @description Whether this event would be part of respective ACS_DELTA shaped stream,
+             *     and should therefore considered when tracking contract activeness on the client-side.
+             *     Required
+             */
+            acsDelta: boolean;
+        };
+        /**
+         * JsInterfaceView
+         * @description View of a create event matched by an interface filter.
+         */
+        JsInterfaceView: {
+            /**
+             * @description The interface implemented by the matched event.
+             *     The identifier uses the package-id reference format.
+             *
+             *     Required
+             */
+            interfaceId: PackageIdString;
+            /**
+             * @description Whether the view was successfully computed, and if not,
+             *     the reason for the error. The error is reported using the same rules
+             *     for error codes and messages as the errors returned for API requests.
+             *     Required
+             */
+            viewStatus: components["schemas"]["JsStatus"];
+            /**
+             * @description The value of the interface's view method on this event.
+             *     Set if it was requested in the ``InterfaceFilter`` and it could be
+             *     successfully computed.
+             *     Optional
+             */
+            viewValue?: unknown;
+        };
+        /** JsEmpty */
+        JsEmpty: Record<string, never>;
+        /** JsIncompleteAssigned */
+        JsIncompleteAssigned: {
+            /** @description Required */
+            assignedEvent: components["schemas"]["JsAssignedEvent"];
+        };
+        /**
+         * JsAssignedEvent
+         * @description Records that a contract has been assigned, and it can be used on the target synchronizer.
+         */
+        JsAssignedEvent: {
+            /**
+             * @description The ID of the source synchronizer.
+             *     Must be a valid synchronizer id.
+             *     Required
+             */
+            source: string;
+            /**
+             * @description The ID of the target synchronizer.
+             *     Must be a valid synchronizer id.
+             *     Required
+             */
+            target: string;
+            /**
+             * @description The ID from the unassigned event.
+             *     For correlation capabilities.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            reassignmentId: LedgerString;
+            /**
+             * @description Party on whose behalf the assign command was executed.
+             *     Empty if the assignment happened offline via the repair service.
+             *     Must be a valid PartyIdString (as described in ``value.proto``).
+             *     Optional
+             */
+            submitter: PartyIdString;
+            /**
+             * Format: int64
+             * @description Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
+             *     with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
+             *     equals zero.
+             *     Required
+             */
+            reassignmentCounter: number;
+            /**
+             * @description Required
+             *     The offset of this event refers to the offset of the assignment,
+             *     while the node_id is the index of within the batch.
+             */
+            createdEvent: components["schemas"]["CreatedEvent"];
+        };
+        /** JsIncompleteUnassigned */
+        JsIncompleteUnassigned: {
+            /**
+             * @description Required
+             *     The event as it appeared in the context of its last activation update (i.e. daml transaction or
+             *     reassignment). In particular, the last activation offset, node_id pair is preserved.
+             *     The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before
+             *     the unassigned_event.
+             *     The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
+             *     for lookups.
+             */
+            createdEvent: components["schemas"]["CreatedEvent"];
+            /** @description Required */
+            unassignedEvent: components["schemas"]["UnassignedEvent"];
+        };
+        /**
+         * UnassignedEvent
+         * @description Records that a contract has been unassigned, and it becomes unusable on the source synchronizer
+         */
+        UnassignedEvent: {
+            /**
+             * @description The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            reassignmentId: LedgerString;
+            /**
+             * @description The ID of the reassigned contract.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            contractId: LedgerString;
+            /**
+             * @description The template of the reassigned contract.
+             *     The identifier uses the package-id reference format.
+             *
+             *     Required
+             */
+            templateId?: PackageIdString;
+            /**
+             * @description The ID of the source synchronizer
+             *     Must be a valid synchronizer id
+             *     Required
+             */
+            source: string;
+            /**
+             * @description The ID of the target synchronizer
+             *     Must be a valid synchronizer id
+             *     Required
+             */
+            target: string;
+            /**
+             * @description Party on whose behalf the unassign command was executed.
+             *     Empty if the unassignment happened offline via the repair service.
+             *     Must be a valid PartyIdString (as described in ``value.proto``).
+             *     Optional
+             */
+            submitter: PartyIdString;
+            /**
+             * Format: int64
+             * @description Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
+             *     with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
+             *     equals zero.
+             *     Required
+             */
+            reassignmentCounter: number;
+            /**
+             * @description Assignment exclusivity
+             *     Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment
+             *     Defined for reassigning participants.
+             *     Optional
+             */
+            assignmentExclusivity?: string;
+            /**
+             * @description The parties that are notified of this event.
+             *     Required
+             */
+            witnessParties?: string[];
+            /**
+             * @description The package name of the contract.
+             *     Required
+             */
+            packageName: string;
+            /**
+             * Format: int64
+             * @description The offset of origin.
+             *     Offsets are managed by the participant nodes.
+             *     Reassignments can thus NOT be assumed to have the same offsets on different participant nodes.
+             *     Required, it is a valid absolute offset (positive integer)
+             */
+            offset: number;
+            /**
+             * Format: int32
+             * @description The position of this event in the originating reassignment.
+             *     Node IDs are not necessarily equal across participants,
+             *     as these may see different projections/parts of reassignments.
+             *     Required, must be valid node ID (non-negative integer)
+             */
+            nodeId: number;
+        };
+        /** GetUpdatesRequest */
+        GetUpdatesRequest: {
+            /**
+             * Format: int64
+             * @description Beginning of the requested ledger section (non-negative integer).
+             *     The response will only contain transactions whose offset is strictly greater than this.
+             *     If zero, the stream will start from the beginning of the ledger.
+             *     If positive, the streaming will start after this absolute offset.
+             *     If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.
+             */
+            beginExclusive: number;
+            /**
+             * Format: int64
+             * @description End of the requested ledger section.
+             *     The response will only contain transactions whose offset is less than or equal to this.
+             *     Optional, if empty, the stream will not terminate.
+             *     If specified, the stream will terminate after this absolute offset (positive integer) is reached.
+             */
+            endInclusive?: number;
+            /**
+             * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+             *     Requesting parties with template filters.
+             *     Template filters must be empty for GetUpdateTrees requests.
+             *     Optional for backwards compatibility, if defined update_format must be unset
+             */
+            filter?: components["schemas"]["TransactionFilter"];
+            /**
+             * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+             *     If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
+             *     In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids
+             *     for record fields.
+             *     Optional for backwards compatibility, if defined update_format must be unset
+             */
+            verbose: boolean;
+            /**
+             * @description Must be unset for GetUpdateTrees request.
+             *     Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:
+             *
+             *     - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request
+             *     - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request
+             *     - include_transactions.event_format.verbose = the same flag specified on this request
+             *     - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
+             *     - include_reassignments.filter = the same filter specified on this request
+             *     - include_reassignments.verbose = the same flag specified on this request
+             *     - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
+             */
+            updateFormat?: components["schemas"]["UpdateFormat"];
+        };
+        /**
+         * UpdateFormat
+         * @description A format specifying what updates to include and how to render them.
+         */
+        UpdateFormat: {
+            /**
+             * @description Include Daml transactions in streams.
+             *     Optional, if unset, no transactions are emitted in the stream.
+             */
+            includeTransactions?: components["schemas"]["TransactionFormat"];
+            /**
+             * @description Include (un)assignments in the stream.
+             *     The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA.
+             *     Optional, if unset, no (un)assignments are emitted in the stream.
+             */
+            includeReassignments?: components["schemas"]["EventFormat"];
+            /**
+             * @description Include topology events in streams.
+             *     Optional, if unset no topology events are emitted in the stream.
+             */
+            includeTopologyEvents?: components["schemas"]["TopologyFormat"];
+        };
+        /**
+         * TransactionFormat
+         * @description A format that specifies what events to include in Daml transactions
+         *     and what data to compute and include for them.
+         */
+        TransactionFormat: {
+            /** @description Required */
+            eventFormat?: components["schemas"]["EventFormat"];
+            /**
+             * @description What transaction shape to use for interpreting the filters of the event format.
+             *     Required
+             * @enum {string}
+             */
+            transactionShape: "TRANSACTION_SHAPE_UNSPECIFIED" | "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS";
+        };
+        /**
+         * TopologyFormat
+         * @description A format specifying which topology transactions to include and how to render them.
+         */
+        TopologyFormat: {
+            /**
+             * @description Include participant authorization topology events in streams.
+             *     Optional, if unset no participant authorization topology events are emitted in the stream.
+             */
+            includeParticipantAuthorizationEvents?: components["schemas"]["ParticipantAuthorizationTopologyFormat"];
+        };
+        /**
+         * ParticipantAuthorizationTopologyFormat
+         * @description A format specifying which participant authorization topology transactions to include and how to render them.
+         */
+        ParticipantAuthorizationTopologyFormat: {
+            /**
+             * @description List of parties for which the topology transactions should be sent.
+             *     Empty means: for all parties.
+             */
+            parties?: string[];
+        };
+        /** Either_JsCantonError_JsGetUpdatesResponse */
+        Either_JsCantonError_JsGetUpdatesResponse: components["schemas"]["JsCantonError"] | components["schemas"]["JsGetUpdatesResponse"];
+        /** JsGetUpdatesResponse */
+        JsGetUpdatesResponse: {
+            update: components["schemas"]["Update"];
+        };
+        /** Update */
+        Update: {
+            OffsetCheckpoint: components["schemas"]["OffsetCheckpoint2"];
+        } | {
+            Reassignment: components["schemas"]["Reassignment"];
+        } | {
+            TopologyTransaction: components["schemas"]["TopologyTransaction"];
+        } | {
+            Transaction: components["schemas"]["Transaction"];
+        };
+        /**
+         * OffsetCheckpoint
+         * @description OffsetCheckpoints may be used to:
+         *
+         *     - detect time out of commands.
+         *     - provide an offset which can be used to restart consumption.
+         */
+        OffsetCheckpoint2: {
+            value: components["schemas"]["OffsetCheckpoint1"];
+        };
+        /**
+         * Reassignment
+         * @description Complete view of an on-ledger reassignment.
+         */
+        Reassignment: {
+            value: components["schemas"]["JsReassignment"];
+        };
+        /**
+         * JsReassignment
+         * @description Complete view of an on-ledger reassignment.
+         */
+        JsReassignment: {
+            /**
+             * @description Assigned by the server. Useful for correlating logs.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            updateId: LedgerString;
+            /**
+             * @description The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            commandId: LedgerString;
+            /**
+             * @description The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            workflowId: LedgerString;
+            /**
+             * Format: int64
+             * @description The participant's offset. The details of this field are described in ``community/ledger-api/README.md``.
+             *     Required, must be a valid absolute offset (positive integer).
+             */
+            offset: number;
+            /** @description The collection of reassignment events. Required. */
+            events?: components["schemas"]["JsReassignmentEvent"][];
+            /**
+             * @description Optional; ledger API trace context
+             *
+             *     The trace context transported in this message corresponds to the trace context supplied
+             *     by the client application in a HTTP2 header of the original command submission.
+             *     We typically use a header to transfer this type of information. Here we use message
+             *     body, because it is used in gRPC streams which do not support per message headers.
+             *     This field will be populated with the trace context contained in the original submission.
+             *     If that was not provided, a unique ledger-api-server generated trace context will be used
+             *     instead.
+             */
+            traceContext?: components["schemas"]["TraceContext"];
+            /**
+             * @description The time at which the reassignment was recorded. The record time refers to the source/target
+             *     synchronizer for an unassign/assign event respectively.
+             *     Required
+             */
+            recordTime: string;
+            /**
+             * @description A valid synchronizer id.
+             *     Identifies the synchronizer that synchronized this Reassignment.
+             *     Required
+             */
+            synchronizerId: string;
+        };
+        /** JsReassignmentEvent */
+        JsReassignmentEvent: {
+            JsAssignmentEvent: components["schemas"]["JsAssignmentEvent"];
+        } | {
+            JsUnassignedEvent: components["schemas"]["JsUnassignedEvent"];
+        };
+        /** JsAssignmentEvent */
+        JsAssignmentEvent: {
+            source: string;
+            target: string;
+            reassignmentId: string;
+            submitter: string;
+            /** Format: int64 */
+            reassignmentCounter: number;
+            createdEvent: components["schemas"]["CreatedEvent"];
+        };
+        /**
+         * JsUnassignedEvent
+         * @description Records that a contract has been unassigned, and it becomes unusable on the source synchronizer
+         */
+        JsUnassignedEvent: {
+            value: components["schemas"]["UnassignedEvent"];
+        };
+        /** TopologyTransaction */
+        TopologyTransaction: {
+            value: components["schemas"]["JsTopologyTransaction"];
+        };
+        /** JsTopologyTransaction */
+        JsTopologyTransaction: {
+            /**
+             * @description Assigned by the server. Useful for correlating logs.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            updateId: LedgerString;
+            /**
+             * Format: int64
+             * @description The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
+             *     Required, it is a valid absolute offset (positive integer).
+             */
+            offset: number;
+            /**
+             * @description A valid synchronizer id.
+             *     Identifies the synchronizer that synchronized the topology transaction.
+             *     Required
+             */
+            synchronizerId: string;
+            /**
+             * @description The time at which the changes in the topology transaction become effective. There is a small delay between a
+             *     topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear
+             *     in order relative to a synchronizer based on their effective time rather than their sequencing time.
+             *     Required
+             */
+            recordTime?: string;
+            /**
+             * @description A non-empty list of topology events.
+             *     Required
+             */
+            events?: components["schemas"]["TopologyEvent"][];
+            /**
+             * @description Optional; ledger API trace context
+             *
+             *     The trace context transported in this message corresponds to the trace context supplied
+             *     by the client application in a HTTP2 header of the original command submission.
+             *     We typically use a header to transfer this type of information. Here we use message
+             *     body, because it is used in gRPC streams which do not support per message headers.
+             *     This field will be populated with the trace context contained in the original submission.
+             *     If that was not provided, a unique ledger-api-server generated trace context will be used
+             *     instead.
+             */
+            traceContext?: components["schemas"]["TraceContext"];
+        };
+        /** TopologyEvent */
+        TopologyEvent: {
+            event: components["schemas"]["TopologyEventEvent"];
+        };
+        /** TopologyEventEvent */
+        TopologyEventEvent: {
+            Empty: components["schemas"]["Empty3"];
+        } | {
+            ParticipantAuthorizationAdded: components["schemas"]["ParticipantAuthorizationAdded"];
+        } | {
+            ParticipantAuthorizationChanged: components["schemas"]["ParticipantAuthorizationChanged"];
+        } | {
+            ParticipantAuthorizationRevoked: components["schemas"]["ParticipantAuthorizationRevoked"];
+        };
+        /** Empty */
+        Empty3: Record<string, never>;
+        /** ParticipantAuthorizationAdded */
+        ParticipantAuthorizationAdded: {
+            value: components["schemas"]["ParticipantAuthorizationAdded1"];
+        };
+        /** ParticipantAuthorizationAdded */
+        ParticipantAuthorizationAdded1: {
+            /** @description Required */
+            partyId: string;
+            /** @description Required */
+            participantId: string;
+            /**
+             * @description Required
+             * @enum {string}
+             */
+            participantPermission: "PARTICIPANT_PERMISSION_UNSPECIFIED" | "PARTICIPANT_PERMISSION_SUBMISSION" | "PARTICIPANT_PERMISSION_CONFIRMATION" | "PARTICIPANT_PERMISSION_OBSERVATION";
+        };
+        /** ParticipantAuthorizationChanged */
+        ParticipantAuthorizationChanged: {
+            value: components["schemas"]["ParticipantAuthorizationChanged1"];
+        };
+        /** ParticipantAuthorizationChanged */
+        ParticipantAuthorizationChanged1: {
+            /** @description Required */
+            partyId: string;
+            /** @description Required */
+            participantId: string;
+            /**
+             * @description Required
+             * @enum {string}
+             */
+            participantPermission: "PARTICIPANT_PERMISSION_UNSPECIFIED" | "PARTICIPANT_PERMISSION_SUBMISSION" | "PARTICIPANT_PERMISSION_CONFIRMATION" | "PARTICIPANT_PERMISSION_OBSERVATION";
+        };
+        /** ParticipantAuthorizationRevoked */
+        ParticipantAuthorizationRevoked: {
+            value: components["schemas"]["ParticipantAuthorizationRevoked1"];
+        };
+        /** ParticipantAuthorizationRevoked */
+        ParticipantAuthorizationRevoked1: {
+            /** @description Required */
+            partyId: string;
+            /** @description Required */
+            participantId: string;
+        };
+        /**
+         * Transaction
+         * @description Filtered view of an on-ledger transaction's create and archive events.
+         */
+        Transaction: {
+            value: components["schemas"]["JsTransaction"];
+        };
+        /**
+         * JsTransaction
+         * @description Filtered view of an on-ledger transaction's create and archive events.
+         */
+        JsTransaction: {
+            /**
+             * @description Assigned by the server. Useful for correlating logs.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            updateId: LedgerString;
+            /**
+             * @description The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            commandId: LedgerString;
+            /**
+             * @description The workflow ID used in command submission.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            workflowId: LedgerString;
+            /**
+             * @description Ledger effective time.
+             *     Required
+             */
+            effectiveAt: string;
+            /**
+             * @description The collection of events.
+             *     Contains:
+             *
+             *     - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape
+             *     - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape
+             *
+             *     Required
+             */
+            events?: components["schemas"]["Event"][];
+            /**
+             * Format: int64
+             * @description The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
+             *     Required, it is a valid absolute offset (positive integer).
+             */
+            offset: number;
+            /**
+             * @description A valid synchronizer id.
+             *     Identifies the synchronizer that synchronized the transaction.
+             *     Required
+             */
+            synchronizerId: string;
+            /**
+             * @description Optional; ledger API trace context
+             *
+             *     The trace context transported in this message corresponds to the trace context supplied
+             *     by the client application in a HTTP2 header of the original command submission.
+             *     We typically use a header to transfer this type of information. Here we use message
+             *     body, because it is used in gRPC streams which do not support per message headers.
+             *     This field will be populated with the trace context contained in the original submission.
+             *     If that was not provided, a unique ledger-api-server generated trace context will be used
+             *     instead.
+             */
+            traceContext?: components["schemas"]["TraceContext"];
+            /**
+             * @description The time at which the transaction was recorded. The record time refers to the synchronizer
+             *     which synchronized the transaction.
+             *     Required
+             */
+            recordTime: string;
+            /**
+             * @description For transaction externally signed, contains the external transaction hash
+             *     signed by the external party. Can be used to correlate an external submission with a committed transaction.
+             *     Optional
+             */
+            externalTransactionHash?: string;
+        };
+        /**
+         * Event
+         * @description Events in transactions can have two primary shapes:
+         *
+         *     - ACS delta: events can be CreatedEvent or ArchivedEvent
+         *     - ledger effects: events can be CreatedEvent or ExercisedEvent
+         *
+         *     In the update service the events are restricted to the events
+         *     visible for the parties specified in the transaction filter. Each
+         *     event message type below contains a ``witness_parties`` field which
+         *     indicates the subset of the requested parties that can see the event
+         *     in question.
+         */
+        Event: {
+            ArchivedEvent: components["schemas"]["ArchivedEvent"];
+        } | {
+            CreatedEvent: components["schemas"]["CreatedEvent"];
+        } | {
+            ExercisedEvent: components["schemas"]["ExercisedEvent"];
+        };
+        /**
+         * ArchivedEvent
+         * @description Records that a contract has been archived, and choices may no longer be exercised on it.
+         */
+        ArchivedEvent: {
+            /**
+             * Format: int64
+             * @description The offset of origin.
+             *     Offsets are managed by the participant nodes.
+             *     Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
+             *     Required, it is a valid absolute offset (positive integer)
+             */
+            offset: number;
+            /**
+             * Format: int32
+             * @description The position of this event in the originating transaction or reassignment.
+             *     Node IDs are not necessarily equal across participants,
+             *     as these may see different projections/parts of transactions.
+             *     Required, must be valid node ID (non-negative integer)
+             */
+            nodeId: number;
+            /**
+             * @description The ID of the archived contract.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            contractId: LedgerString;
+            /**
+             * @description Identifies the template that defines the choice that archived the contract.
+             *     This template's package-id may differ from the target contract's package-id
+             *     if the target contract has been upgraded or downgraded.
+             *
+             *     The identifier uses the package-id reference format.
+             *
+             *     Required
+             */
+            templateId: PackageIdString;
+            /**
+             * @description The parties that are notified of this event. For an ``ArchivedEvent``,
+             *     these are the intersection of the stakeholders of the contract in
+             *     question and the parties specified in the ``TransactionFilter``. The
+             *     stakeholders are the union of the signatories and the observers of
+             *     the contract.
+             *     Each one of its elements must be a valid PartyIdString (as described
+             *     in ``value.proto``).
+             *     Required
+             */
+            witnessParties?: string[];
+            /**
+             * @description The package name of the contract.
+             *     Required
+             */
+            packageName: string;
+            /**
+             * @description The interfaces implemented by the target template that have been
+             *     matched from the interface filter query.
+             *     Populated only in case interface filters with include_interface_view set.
+             *
+             *     If defined, the identifier uses the package-id reference format.
+             *
+             *     Optional
+             */
+            implementedInterfaces?: string[];
+        };
+        /**
+         * ExercisedEvent
+         * @description Records that a choice has been exercised on a target contract.
+         */
+        ExercisedEvent: {
+            /**
+             * Format: int64
+             * @description The offset of origin.
+             *     Offsets are managed by the participant nodes.
+             *     Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
+             *     Required, it is a valid absolute offset (positive integer)
+             */
+            offset: number;
+            /**
+             * Format: int32
+             * @description The position of this event in the originating transaction or reassignment.
+             *     Node IDs are not necessarily equal across participants,
+             *     as these may see different projections/parts of transactions.
+             *     Required, must be valid node ID (non-negative integer)
+             */
+            nodeId: number;
+            /**
+             * @description The ID of the target contract.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            contractId: LedgerString;
+            /**
+             * @description Identifies the template that defines the executed choice.
+             *     This template's package-id may differ from the target contract's package-id
+             *     if the target contract has been upgraded or downgraded.
+             *
+             *     The identifier uses the package-id reference format.
+             *
+             *     Required
+             */
+            templateId: PackageIdString;
+            /**
+             * @description The interface where the choice is defined, if inherited.
+             *     If defined, the identifier uses the package-id reference format.
+             *
+             *     Optional
+             */
+            interfaceId?: string;
+            /**
+             * @description The choice that was exercised on the target contract.
+             *     Must be a valid NameString (as described in ``value.proto``).
+             *     Required
+             */
+            choice: NameString;
+            /**
+             * @description The argument of the exercised choice.
+             *     Required
+             */
+            choiceArgument: unknown;
+            /**
+             * @description The parties that exercised the choice.
+             *     Each element must be a valid PartyIdString (as described in ``value.proto``).
+             *     Required
+             */
+            actingParties?: string[];
+            /**
+             * @description If true, the target contract may no longer be exercised.
+             *     Required
+             */
+            consuming: boolean;
+            /**
+             * @description The parties that are notified of this event. The witnesses of an exercise
+             *     node will depend on whether the exercise was consuming or not.
+             *     If consuming, the witnesses are the union of the stakeholders,
+             *     the actors and all informees of all the ancestors of this event this
+             *     participant knows about.
+             *     If not consuming, the witnesses are the union of the signatories,
+             *     the actors and all informees of all the ancestors of this event this
+             *     participant knows about.
+             *     In both cases the witnesses are limited to the querying parties, or not
+             *     limited in case anyParty filters are used.
+             *     Note that the actors might not necessarily be observers
+             *     and thus stakeholders. This is the case when the controllers of a
+             *     choice are specified using "flexible controllers", using the
+             *     ``choice ... controller`` syntax, and said controllers are not
+             *     explicitly marked as observers.
+             *     Each element must be a valid PartyIdString (as described in ``value.proto``).
+             *     Required
+             */
+            witnessParties?: string[];
+            /**
+             * Format: int32
+             * @description Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of
+             *     this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this
+             *     node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily
+             *     filtered, it is only possible to determine if a node is in a consequent subtree or not.
+             *     Required
+             */
+            lastDescendantNodeId: number;
+            /**
+             * @description The result of exercising the choice.
+             *     Required
+             */
+            exerciseResult: unknown;
+            /**
+             * @description The package name of the contract.
+             *     Required
+             */
+            packageName: string;
+            /**
+             * @description If the event is consuming, the interfaces implemented by the target template that have been
+             *     matched from the interface filter query.
+             *     Populated only in case interface filters with include_interface_view set.
+             *
+             *     The identifier uses the package-id reference format.
+             *
+             *     Optional
+             */
+            implementedInterfaces?: PackageIdString[];
+            /**
+             * @description Whether this event would be part of respective ACS_DELTA shaped stream,
+             *     and should therefore considered when tracking contract activeness on the client-side.
+             *     Required
+             */
+            acsDelta: boolean;
+        };
+        /** Either_JsCantonError_JsGetUpdateTreesResponse */
+        Either_JsCantonError_JsGetUpdateTreesResponse: components["schemas"]["JsCantonError"] | components["schemas"]["JsGetUpdateTreesResponse"];
+        /**
+         * JsGetUpdateTreesResponse
+         * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+         */
+        JsGetUpdateTreesResponse: {
+            update: components["schemas"]["Update1"];
+        };
+        /** Update */
+        Update1: {
+            OffsetCheckpoint: components["schemas"]["OffsetCheckpoint3"];
+        } | {
+            Reassignment: components["schemas"]["Reassignment1"];
+        } | {
+            TransactionTree: components["schemas"]["TransactionTree"];
+        };
+        /**
+         * OffsetCheckpoint
+         * @description OffsetCheckpoints may be used to:
+         *
+         *     - detect time out of commands.
+         *     - provide an offset which can be used to restart consumption.
+         */
+        OffsetCheckpoint3: {
+            value: components["schemas"]["OffsetCheckpoint1"];
+        };
+        /**
+         * Reassignment
+         * @description Complete view of an on-ledger reassignment.
+         */
+        Reassignment1: {
+            value: components["schemas"]["JsReassignment"];
+        };
+        /**
+         * TransactionTree
+         * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+         *     Complete view of an on-ledger transaction.
+         */
+        TransactionTree: {
+            value: components["schemas"]["JsTransactionTree"];
+        };
+        /**
+         * JsTransactionTree
+         * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+         *     Complete view of an on-ledger transaction.
+         */
+        JsTransactionTree: {
+            /**
+             * @description Assigned by the server. Useful for correlating logs.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Required
+             */
+            updateId: LedgerString;
+            /**
+             * @description The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            commandId: LedgerString;
+            /**
+             * @description The workflow ID used in command submission. Only set if the ``workflow_id`` for the command was set.
+             *     Must be a valid LedgerString (as described in ``value.proto``).
+             *     Optional
+             */
+            workflowId: LedgerString;
+            /**
+             * @description Ledger effective time.
+             *     Required
+             */
+            effectiveAt?: string;
+            /**
+             * Format: int64
+             * @description The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
+             *     Required, it is a valid absolute offset (positive integer).
+             */
+            offset: number;
+            /**
+             * @description Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
+             *     Each key must be a valid node ID (non-negative integer).
+             *     Required
+             */
+            eventsById: components["schemas"]["Map_Int_TreeEvent"];
+            /**
+             * @description A valid synchronizer id.
+             *     Identifies the synchronizer that synchronized the transaction.
+             *     Required
+             */
+            synchronizerId: string;
+            /**
+             * @description Optional; ledger API trace context
+             *
+             *     The trace context transported in this message corresponds to the trace context supplied
+             *     by the client application in a HTTP2 header of the original command submission.
+             *     We typically use a header to transfer this type of information. Here we use message
+             *     body, because it is used in gRPC streams which do not support per message headers.
+             *     This field will be populated with the trace context contained in the original submission.
+             *     If that was not provided, a unique ledger-api-server generated trace context will be used
+             *     instead.
+             */
+            traceContext?: components["schemas"]["TraceContext"];
+            /**
+             * @description The time at which the transaction was recorded. The record time refers to the synchronizer
+             *     which synchronized the transaction.
+             *     Required
+             */
+            recordTime: string;
+        };
+        /** Map_Int_TreeEvent */
+        Map_Int_TreeEvent: {
+            [key: string]: components["schemas"]["TreeEvent"];
+        };
+        /**
+         * TreeEvent
+         * @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
+         *     Each tree event message type below contains a ``witness_parties`` field which
+         *     indicates the subset of the requested parties that can see the event
+         *     in question.
+         *
+         *     Note that transaction trees might contain events with
+         *     _no_ witness parties, which were included simply because they were
+         *     children of events which have witnesses.
+         */
+        TreeEvent: {
+            CreatedTreeEvent: components["schemas"]["CreatedTreeEvent"];
+        } | {
+            ExercisedTreeEvent: components["schemas"]["ExercisedTreeEvent"];
+        };
+        /** CreatedTreeEvent */
+        CreatedTreeEvent: {
+            value: components["schemas"]["CreatedEvent"];
+        };
+        /** ExercisedTreeEvent */
+        ExercisedTreeEvent: {
+            value: components["schemas"]["ExercisedEvent"];
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;
+export interface channels {
+    "/v2/commands/completions": {
+        /** @description Get completions stream */
+        publish: {
+            /** @description Get completions stream */
+            message: components["schemas"]["CompletionStreamRequest"];
+        };
+        subscribe: {
+            /** @description Get completions stream */
+            message: components["schemas"]["Either_JsCantonError_CompletionStreamResponse"];
+        };
+    };
+    "/v2/state/active-contracts": {
+        /** @description Get active contracts stream */
+        publish: {
+            /** @description Get active contracts stream */
+            message: components["schemas"]["GetActiveContractsRequest"];
+        };
+        subscribe: {
+            /** @description Get active contracts stream */
+            message: components["schemas"]["Either_JsCantonError_JsGetActiveContractsResponse"];
+        };
+    };
+    "/v2/updates": {
+        /** @description Get updates stream */
+        publish: {
+            /** @description Get updates stream */
+            message: components["schemas"]["GetUpdatesRequest"];
+        };
+        subscribe: {
+            /** @description Get updates stream */
+            message: components["schemas"]["Either_JsCantonError_JsGetUpdatesResponse"];
+        };
+    };
+    "/v2/updates/flats": {
+        /** @description Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. */
+        publish: {
+            /** @description Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. */
+            message: components["schemas"]["GetUpdatesRequest"];
+        };
+        subscribe: {
+            /** @description Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. */
+            message: components["schemas"]["Either_JsCantonError_JsGetUpdatesResponse"];
+        };
+    };
+    "/v2/updates/trees": {
+        /** @description Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. */
+        publish: {
+            /** @description Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. */
+            message: components["schemas"]["GetUpdatesRequest"];
+        };
+        subscribe: {
+            /** @description Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. */
+            message: components["schemas"]["Either_JsCantonError_JsGetUpdateTreesResponse"];
+        };
+    };
+}