@q9labsai/chalk-client 4.0.0

package/dist/webhooks/generated/event-v1.d.cts

@@ -0,0 +1,764 @@
+export declare const webhookEventSchemaV1: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://chalk.dev/contracts/webhooks/v1/event.schema.json";
+    readonly title: "Chalk webhook Event version 1";
+    readonly type: "object";
+    readonly required: readonly ["id", "event", "api_version", "occurred_at", "tenant_id", "data"];
+    readonly properties: {
+        readonly id: {
+            readonly $ref: "#/$defs/uuid";
+        };
+        readonly event: {
+            readonly type: "string";
+        };
+        readonly api_version: {
+            readonly const: 1;
+        };
+        readonly occurred_at: {
+            readonly $ref: "#/$defs/timestamp";
+        };
+        readonly tenant_id: {
+            readonly $ref: "#/$defs/uuid";
+        };
+        readonly data: {
+            readonly type: "object";
+        };
+    };
+    readonly additionalProperties: true;
+    readonly oneOf: readonly [{
+        readonly $ref: "#/$defs/spaceCreated";
+    }, {
+        readonly $ref: "#/$defs/spaceUpdated";
+    }, {
+        readonly $ref: "#/$defs/spaceArchived";
+    }, {
+        readonly $ref: "#/$defs/spaceRestored";
+    }, {
+        readonly $ref: "#/$defs/episodeStarted";
+    }, {
+        readonly $ref: "#/$defs/episodeEnded";
+    }, {
+        readonly $ref: "#/$defs/participantJoined";
+    }, {
+        readonly $ref: "#/$defs/participantLeft";
+    }, {
+        readonly $ref: "#/$defs/recordingStarted";
+    }, {
+        readonly $ref: "#/$defs/recordingCompleted";
+    }, {
+        readonly $ref: "#/$defs/recordingFailed";
+    }, {
+        readonly $ref: "#/$defs/transcriptStarted";
+    }, {
+        readonly $ref: "#/$defs/transcriptCompleted";
+    }, {
+        readonly $ref: "#/$defs/transcriptFailed";
+    }, {
+        readonly $ref: "#/$defs/endpointTest";
+    }];
+    readonly $defs: {
+        readonly uuid: {
+            readonly type: "string";
+            readonly format: "uuid";
+            readonly pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$";
+        };
+        readonly timestamp: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$";
+        };
+        readonly nullableTimestamp: {
+            readonly oneOf: readonly [{
+                readonly $ref: "#/$defs/timestamp";
+            }, {
+                readonly type: "null";
+            }];
+        };
+        readonly nullableUUID: {
+            readonly oneOf: readonly [{
+                readonly $ref: "#/$defs/uuid";
+            }, {
+                readonly type: "null";
+            }];
+        };
+        readonly failure: {
+            readonly oneOf: readonly [{
+                readonly type: "null";
+            }, {
+                readonly type: "object";
+                readonly required: readonly ["code"];
+                readonly properties: {
+                    readonly code: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 96;
+                    };
+                };
+                readonly additionalProperties: true;
+            }];
+        };
+        readonly spaceObject: {
+            readonly type: "object";
+            readonly required: readonly ["id", "name", "slug", "media_plane", "created_at", "updated_at"];
+            readonly properties: {
+                readonly id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly slug: {
+                    readonly type: "string";
+                };
+                readonly media_plane: {
+                    readonly type: "string";
+                };
+                readonly archived_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+                readonly created_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly updated_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly episodeObject: {
+            readonly type: "object";
+            readonly required: readonly ["id", "space_id", "status", "started_at", "ended_at", "created_at", "updated_at"];
+            readonly properties: {
+                readonly id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly space_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly status: {
+                    readonly enum: readonly ["active", "ended"];
+                };
+                readonly started_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly ended_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+                readonly created_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly updated_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly participantObject: {
+            readonly type: "object";
+            readonly required: readonly ["id", "identity_id", "space_id", "episode_id", "name", "status", "joined_at", "left_at"];
+            readonly properties: {
+                readonly id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly identity_id: {
+                    readonly $ref: "#/$defs/nullableUUID";
+                };
+                readonly space_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly episode_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly name: {
+                    readonly type: readonly ["string", "null"];
+                };
+                readonly status: {
+                    readonly enum: readonly ["active", "left"];
+                };
+                readonly joined_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly left_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly recordingObject: {
+            readonly type: "object";
+            readonly required: readonly ["id", "space_id", "episode_id", "status", "started_at", "completed_at", "failed_at", "failure", "created_at", "updated_at"];
+            readonly properties: {
+                readonly id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly space_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly episode_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly status: {
+                    readonly enum: readonly ["started", "completed", "failed"];
+                };
+                readonly started_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly completed_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+                readonly failed_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+                readonly failure: {
+                    readonly $ref: "#/$defs/failure";
+                };
+                readonly created_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly updated_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly transcriptObject: {
+            readonly type: "object";
+            readonly required: readonly ["id", "recording_id", "space_id", "episode_id", "status", "languages", "started_at", "completed_at", "failed_at", "failure", "created_at", "updated_at"];
+            readonly properties: {
+                readonly id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly recording_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly space_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly episode_id: {
+                    readonly $ref: "#/$defs/uuid";
+                };
+                readonly status: {
+                    readonly enum: readonly ["started", "completed", "failed"];
+                };
+                readonly languages: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly uniqueItems: true;
+                };
+                readonly started_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly completed_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+                readonly failed_at: {
+                    readonly $ref: "#/$defs/nullableTimestamp";
+                };
+                readonly failure: {
+                    readonly $ref: "#/$defs/failure";
+                };
+                readonly created_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+                readonly updated_at: {
+                    readonly $ref: "#/$defs/timestamp";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly spaceData: {
+            readonly type: "object";
+            readonly required: readonly ["object"];
+            readonly properties: {
+                readonly object: {
+                    readonly $ref: "#/$defs/spaceObject";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly spaceUpdatedData: {
+            readonly type: "object";
+            readonly required: readonly ["object", "changed_fields"];
+            readonly properties: {
+                readonly object: {
+                    readonly $ref: "#/$defs/spaceObject";
+                };
+                readonly changed_fields: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly enum: readonly ["admission_policy", "default_episode_duration_seconds", "linger_window_seconds", "maximum_episode_duration_seconds", "media_plane", "metadata", "name", "recurring_policy", "slug"];
+                    };
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly episodeData: {
+            readonly type: "object";
+            readonly required: readonly ["object"];
+            readonly properties: {
+                readonly object: {
+                    readonly $ref: "#/$defs/episodeObject";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly participantData: {
+            readonly type: "object";
+            readonly required: readonly ["object"];
+            readonly properties: {
+                readonly object: {
+                    readonly $ref: "#/$defs/participantObject";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly recordingData: {
+            readonly type: "object";
+            readonly required: readonly ["object"];
+            readonly properties: {
+                readonly object: {
+                    readonly $ref: "#/$defs/recordingObject";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly transcriptData: {
+            readonly type: "object";
+            readonly required: readonly ["object"];
+            readonly properties: {
+                readonly object: {
+                    readonly $ref: "#/$defs/transcriptObject";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly spaceCreated: {
+            readonly $ref: "#/$defs/spaceCreatedShape";
+        };
+        readonly spaceCreatedShape: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "space.created";
+                };
+                readonly data: {
+                    readonly $ref: "#/$defs/spaceData";
+                };
+            };
+        };
+        readonly spaceUpdated: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "space.updated";
+                };
+                readonly data: {
+                    readonly $ref: "#/$defs/spaceUpdatedData";
+                };
+            };
+        };
+        readonly spaceArchived: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "space.archived";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/spaceData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly required: readonly ["archived_at"];
+                                readonly properties: {
+                                    readonly archived_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly spaceRestored: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "space.restored";
+                };
+                readonly data: {
+                    readonly $ref: "#/$defs/spaceData";
+                };
+            };
+        };
+        readonly episodeStarted: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "episode.started";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/episodeData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "active";
+                                    };
+                                    readonly ended_at: {
+                                        readonly type: "null";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly episodeEnded: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "episode.ended";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/episodeData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "ended";
+                                    };
+                                    readonly ended_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly participantJoined: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "participant.joined";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/participantData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "active";
+                                    };
+                                    readonly left_at: {
+                                        readonly type: "null";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly participantLeft: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "participant.left";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/participantData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "left";
+                                    };
+                                    readonly left_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly recordingStarted: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "recording.started";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/recordingData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "started";
+                                    };
+                                    readonly completed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failure: {
+                                        readonly type: "null";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly recordingCompleted: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "recording.completed";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/recordingData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "completed";
+                                    };
+                                    readonly completed_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                    readonly failed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failure: {
+                                        readonly type: "null";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly recordingFailed: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "recording.failed";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/recordingData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "failed";
+                                    };
+                                    readonly completed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failed_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                    readonly failure: {
+                                        readonly type: "object";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly transcriptStarted: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "transcript.started";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/transcriptData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "started";
+                                    };
+                                    readonly completed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failure: {
+                                        readonly type: "null";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly transcriptCompleted: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "transcript.completed";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/transcriptData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "completed";
+                                    };
+                                    readonly completed_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                    readonly failed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failure: {
+                                        readonly type: "null";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly transcriptFailed: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "transcript.failed";
+                };
+                readonly data: {
+                    readonly allOf: readonly [{
+                        readonly $ref: "#/$defs/transcriptData";
+                    }, {
+                        readonly properties: {
+                            readonly object: {
+                                readonly properties: {
+                                    readonly status: {
+                                        readonly const: "failed";
+                                    };
+                                    readonly completed_at: {
+                                        readonly type: "null";
+                                    };
+                                    readonly failed_at: {
+                                        readonly $ref: "#/$defs/timestamp";
+                                    };
+                                    readonly failure: {
+                                        readonly type: "object";
+                                    };
+                                };
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly endpointTest: {
+            readonly properties: {
+                readonly event: {
+                    readonly const: "endpoint.test";
+                };
+                readonly data: {
+                    readonly type: "object";
+                    readonly required: readonly ["object"];
+                    readonly properties: {
+                        readonly object: {
+                            readonly type: "object";
+                            readonly required: readonly ["endpoint_id"];
+                            readonly properties: {
+                                readonly endpoint_id: {
+                                    readonly $ref: "#/$defs/uuid";
+                                };
+                            };
+                            readonly additionalProperties: true;
+                        };
+                    };
+                    readonly additionalProperties: true;
+                };
+            };
+        };
+    };
+};
+export declare const knownWebhookEventNamesV1: readonly ["space.created", "space.updated", "space.archived", "space.restored", "episode.started", "episode.ended", "participant.joined", "participant.left", "recording.started", "recording.completed", "recording.failed", "transcript.started", "transcript.completed", "transcript.failed", "endpoint.test"];
+export type KnownWebhookEventNameV1 = (typeof knownWebhookEventNamesV1)[number];
+type JsonObject = Readonly<Record<string, unknown>>;
+type Defs = typeof webhookEventSchemaV1.$defs;
+type RefName<Ref extends string> = Ref extends `#/$defs/${infer Name}` ? Name : never;
+type ResolveRef<Ref extends string> = RefName<Ref> extends keyof Defs ? SchemaType<Defs[RefName<Ref>]> : unknown;
+type RequiredKeys<Schema> = Schema extends {
+    readonly required: readonly (infer Key extends string)[];
+} ? Key : never;
+type PropertiesType<Schema extends {
+    readonly properties: Readonly<Record<string, unknown>>;
+}> = {
+    readonly [Key in keyof Schema["properties"] as Key extends RequiredKeys<Schema> ? Key : never]-?: SchemaType<Schema["properties"][Key]>;
+} & {
+    readonly [Key in keyof Schema["properties"] as Key extends RequiredKeys<Schema> ? never : Key]?: SchemaType<Schema["properties"][Key]>;
+} & JsonObject;
+type TypeName<Value> = Value extends "string" ? string : Value extends "number" | "integer" ? number : Value extends "boolean" ? boolean : Value extends "null" ? null : Value extends "array" ? readonly unknown[] : Value extends "object" ? JsonObject : unknown;
+type TypeNames<Values> = Values extends readonly (infer Value)[] ? TypeName<Value> : TypeName<Values>;
+type SchemaBase<Schema> = Schema extends {
+    readonly $ref: infer Ref extends string;
+} ? ResolveRef<Ref> : Schema extends {
+    readonly const: infer Value;
+} ? Value : Schema extends {
+    readonly enum: readonly (infer Value)[];
+} ? Value : Schema extends {
+    readonly properties: Readonly<Record<string, unknown>>;
+} ? PropertiesType<Schema> : Schema extends {
+    readonly type: "array";
+    readonly items: infer Item;
+} ? readonly SchemaType<Item>[] : Schema extends {
+    readonly type: infer Type;
+} ? TypeNames<Type> : unknown;
+type SchemaBranches<Schema> = Schema extends {
+    readonly oneOf: readonly (infer Branch)[];
+} ? SchemaType<Branch> : unknown;
+type SchemaAllOf<Schema> = Schema extends {
+    readonly allOf: readonly [infer First, ...infer Rest];
+} ? SchemaType<First> & SchemaAllOf<{
+    readonly allOf: Rest;
+}> : unknown;
+export type SchemaType<Schema> = SchemaBase<Schema> & SchemaBranches<Schema> & SchemaAllOf<Schema>;
+export type KnownWebhookEventV1 = SchemaType<typeof webhookEventSchemaV1>;
+export type SpaceWebhookEvent = Extract<KnownWebhookEventV1, {
+    readonly event: `space.${string}`;
+}>;
+export type ParticipantWebhookEvent = Extract<KnownWebhookEventV1, {
+    readonly event: `participant.${string}`;
+}>;
+export type RecordingWebhookEvent = Extract<KnownWebhookEventV1, {
+    readonly event: `recording.${string}`;
+}>;
+export type TranscriptWebhookEvent = Extract<KnownWebhookEventV1, {
+    readonly event: `transcript.${string}`;
+}>;
+export type EndpointTestWebhookEvent = Extract<KnownWebhookEventV1, {
+    readonly event: "endpoint.test";
+}>;
+export {};