@fairmint/canton-node-sdk
Version:
Canton Node SDK
39 lines • 2 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/users/{user-id}";
export declare const GetUserParamsSchema: z.ZodObject<{
userId: z.ZodString;
identityProviderId: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type GetUserParams = z.infer<typeof GetUserParamsSchema>;
export type GetUserResponse = paths[typeof endpoint]['get']['responses']['200']['content']['application/json'];
/**
* @description Get details for a specific user
* @example
* ```typescript
* const user = await client.getUser({ userId: 'alice' });
* console.log(`User ${user.user.id} is ${user.user.isDeactivated ? 'deactivated' : 'active'}`);
* ```
*/
export declare const GetUser: {
new (client: import("../../../../../core").BaseClient): {
execute(params: {
userId: string;
identityProviderId?: string | undefined;
}): Promise<{
user?: import("../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi").components["schemas"]["User"];
}>;
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-user.d.ts.map