TypeScript SDKTypeScript signatures
client.connections
TypeScript client.connections signature, generated from CerealClient.
This is the TypeScript interface. See client setup and behavior.
interface ClientSurface {
readonly connections: {
list(): Promise<ReadonlyArray<Connection>>;
get(input: {
readonly id: string;
}): Promise<Connection>;
getBySlug(input: {
readonly slug: string;
}): Promise<Connection>;
getByName(input: {
readonly name: string;
}): Promise<Connection>;
create(input: ConnectionCreate): Promise<Connection>;
upsert(input: ConnectionCreate): Promise<Connection>;
delete(input: {
readonly id: string;
}): Promise<void>;
test(input: {
readonly id: string;
}): Promise<ConnectionTestResult>;
jwks(): Promise<CerealJwks>;
authorize(input: {
readonly connectionId: string;
readonly identity: Identity;
readonly redirectUri?: string;
readonly scopes?: ReadonlyArray<string>;
readonly sessionId?: string;
}): Promise<AuthorizationStart>;
status(input?: {
readonly sessionId?: string;
readonly identity?: Identity;
}): Promise<ReadonlyArray<ConnectionStatus>>;
readonly grants: {
list(input?: {
readonly connectionId?: string;
readonly identity?: Identity;
readonly status?: GrantStatus;
}): Promise<ReadonlyArray<ConnectionGrant>>;
revoke(input: {
readonly id: string;
}): Promise<void>;
import(input: {
readonly connectionId: string;
readonly mode: ImportMode;
readonly grants: ReadonlyArray<GrantImport>;
}): Promise<{
readonly results: ReadonlyArray<GrantImportResult>;
}>;
};
};
}For the wire contract, use HTTP reference. Composite helpers are explained in the API/SDK map.