@fairmint/canton-node-sdk
Version:
Canton Node SDK
43 lines • 2.4 kB
TypeScript
import { z } from 'zod';
import type { paths } from '../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi';
declare const endpoint = "/v2/events/events-by-contract-id";
export declare const EventsByContractIdParamsSchema: z.ZodObject<{
contractId: z.ZodString;
readAs: z.ZodOptional<z.ZodArray<z.ZodString>>;
}, z.core.$strip>;
export type EventsByContractIdParams = z.infer<typeof EventsByContractIdParamsSchema>;
export type EventsByContractIdRequest = paths[typeof endpoint]['post']['requestBody']['content']['application/json'];
export type EventsByContractIdResponse = paths[typeof endpoint]['post']['responses']['200']['content']['application/json'];
/**
* @description Retrieves events for a specific contract ID with filtering options
* @example
* ```typescript
* const events = await client.getEventsByContractId({
* contractId: 'contract-123',
* readAs: ['party1', 'party2']
* });
* ```
*/
export declare const GetEventsByContractId: {
new (client: import("../../../../../core").BaseClient): {
execute(params: {
contractId: string;
readAs?: string[] | undefined;
}): Promise<{
created?: import("../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi").components["schemas"]["JsCreated"];
archived?: import("../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi").components["schemas"]["JsArchived"];
}>;
client: import("../../../../../core").BaseClient;
validateParams<T>(params: T, schema: z.ZodSchema<T>): T;
makeGetRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
makePostRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
makeDeleteRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
makePatchRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
getManagedParties(): string[];
getPartyId(): string | undefined;
getApiUrl(): string;
buildPartyList(additionalParties?: string[]): string[];
};
};
export {};
//# sourceMappingURL=get-events-by-contract-id.d.ts.map