@raconte/node-sdk 0.1.0

package/dist/generated/types.gen.d.ts

@@ -0,0 +1,705 @@
+export type ClientOptions = {
+    baseUrl: "https://api.raconte.ai" | (string & {});
+};
+/**
+ * VoiceTestAudioUrlSchema
+ *
+ * Short-lived presigned URL for the voice preview audio. Generated on first request if missing.
+ */
+export type VoiceTestAudioUrlSchema = {
+    url: string;
+    expiresAt: string;
+    mimeType: string;
+};
+/**
+ * VoiceListSchema
+ *
+ * List of voices matching the requested language filter.
+ */
+export type VoiceListSchema = Array<VoiceSchema>;
+/**
+ * VoiceSchema
+ *
+ * A voice available for interview narration. Provider-specific identifiers are not exposed publicly.
+ */
+export type VoiceSchema = {
+    id: string;
+    name: string;
+    language: string;
+    gender: "M" | "F";
+    provider: "gradium" | "elevenlabs";
+};
+/**
+ * InterviewMessageAudioUrlSchema
+ *
+ * Short-lived presigned URL for the audio attached to an interview message.
+ */
+export type InterviewMessageAudioUrlSchema = {
+    url: string;
+    expiresAt: string;
+    mimeType: string;
+};
+/**
+ * InterviewLogListSchema
+ *
+ * Chronological history of events on an interview, most recent first.
+ */
+export type InterviewLogListSchema = Array<InterviewLogSchema>;
+/**
+ * InterviewLogSchema
+ *
+ * Schema for a single interview log entry. target is the email or phone for send events, null for status transitions. invitationId points to the specific invitation that the event concerns; null for legacy rows that predate the invitation split.
+ */
+export type InterviewLogSchema = {
+    id: string;
+    /**
+     * InterviewLogType
+     *
+     * Type of an interview log event. archived/restored are interview-level transitions (no invitationId); the others are invitation-scoped.
+     */
+    type: "email_sent" | "sms_sent" | "started" | "completed" | "cancelled" | "reactivated" | "archived" | "restored";
+    target: string | null;
+    invitationId: string | null;
+    createdAt: string;
+};
+/**
+ * InterviewInvitationSchema
+ *
+ * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+ */
+export type InterviewInvitationSchema = {
+    id: string;
+    interviewId: string;
+    slug: string;
+    status: InterviewInvitationStatus;
+    name: string | null;
+    recipientEmail: string | null;
+    recipientPhone: string | null;
+    summary: string | null;
+    archivedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    messages?: Array<InterviewMessageSchema>;
+};
+/**
+ * InterviewMessageSchema
+ *
+ * Schema for an interview message. audioAssetId is null when no audio was recorded for that message (legacy messages, deleted audio, etc.). audioPeaks is a base64-encoded uint8 waveform summary of the attached audio (128 amplitude bins, 0-255), null when no audio is attached or when peaks have not been computed yet for a legacy asset. sentiment is populated only on user-role messages once async insights generation has completed.
+ */
+export type InterviewMessageSchema = {
+    id: string;
+    role: "user" | "assistant" | "system";
+    content: string;
+    audioAssetId: string | null;
+    audioDurationMs: number | null;
+    audioPeaks: string | null;
+    sentiment: "positive" | "neutral" | "negative" | null;
+    createdAt: string;
+};
+/**
+ * InterviewInvitationStatus
+ *
+ * Lifecycle state of an invitation (the unit that gets sent and produces a transcript).
+ */
+export declare const InterviewInvitationStatus: {
+    readonly READY: "ready";
+    readonly IN_PROGRESS: "in_progress";
+    readonly COMPLETED: "completed";
+    readonly CANCELLED: "cancelled";
+};
+/**
+ * InterviewInvitationStatus
+ *
+ * Lifecycle state of an invitation (the unit that gets sent and produces a transcript).
+ */
+export type InterviewInvitationStatus = (typeof InterviewInvitationStatus)[keyof typeof InterviewInvitationStatus];
+/**
+ * InterviewInvitationListSchema
+ *
+ * List of interview invitations belonging to an interview.
+ */
+export type InterviewInvitationListSchema = Array<InterviewInvitationSchema>;
+/**
+ * RestoreInterviewResponse
+ *
+ * Response for restoring an archived interview
+ */
+export type RestoreInterviewResponse = {
+    success: boolean;
+};
+/**
+ * ArchiveInterviewResponse
+ *
+ * Response for archiving an interview
+ */
+export type ArchiveInterviewResponse = {
+    success: boolean;
+};
+/**
+ * InterviewSchema
+ *
+ * Schema for an interview definition. invitations is the list of recipients this interview has been (or will be) sent to. When invitationsCount == 1, the interview is in "single" mode; when > 1, it is a bulk send.
+ */
+export type InterviewSchema = {
+    id: string;
+    title: string | null;
+    prompt: string;
+    intro: string | null;
+    firstMessage: string | null;
+    locale: string | null;
+    voiceId: string;
+    maxMinutes: number;
+    maxResponses: number;
+    disableOrgSystemPrompt: boolean;
+    createdAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    invitationsCount: number;
+    invitationsByStatus: InterviewStatusCounts;
+    invitationsArchivedCount: number;
+    invitations: Array<InterviewInvitationSummarySchema>;
+};
+/**
+ * InterviewInvitationSummarySchema
+ *
+ * Lightweight invitation row used in lists. summaryAvailable is true once async insights have produced a summary for this invitation. hasMessages is true as soon as the invitation has at least one transcript message persisted.
+ */
+export type InterviewInvitationSummarySchema = {
+    id: string;
+    slug: string;
+    /**
+     * InterviewInvitationStatus
+     *
+     * Lifecycle state of an invitation (the unit that gets sent and produces a transcript).
+     */
+    status: "ready" | "in_progress" | "completed" | "cancelled";
+    name: string | null;
+    recipientEmail: string | null;
+    recipientPhone: string | null;
+    archivedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    hasMessages: boolean;
+    summaryAvailable: boolean;
+};
+/**
+ * InterviewStatusCounts
+ *
+ * Number of invitations in each status for a given interview, archived invitations excluded.
+ */
+export type InterviewStatusCounts = {
+    ready: number;
+    in_progress: number;
+    completed: number;
+    cancelled: number;
+};
+/**
+ * InterviewListSchema
+ *
+ * Schema for a list of interviews
+ */
+export type InterviewListSchema = Array<InterviewSchema>;
+/**
+ * CreatedInterviewsResponse
+ *
+ * Response for interview creation
+ */
+export type CreatedInterviewsResponse = Array<CreatedInterviewSchema>;
+/**
+ * CreatedInterviewSchema
+ *
+ * Schema for a newly created interview, including the slug of its initial invitation.
+ */
+export type CreatedInterviewSchema = {
+    id: string;
+    invitationId: string;
+    slug: string;
+    /**
+     * InterviewInvitationStatus
+     *
+     * Lifecycle state of an invitation (the unit that gets sent and produces a transcript).
+     */
+    status: "ready" | "in_progress" | "completed" | "cancelled";
+};
+export type InterviewsControllerListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * When true, returns archived interviews only. When omitted or false, returns active (non-archived) interviews.
+         */
+        archived?: boolean;
+    };
+    url: "/api/interviews";
+};
+export type InterviewsControllerListResponses = {
+    /**
+     * Schema for a list of interviews
+     */
+    200: InterviewListSchema;
+};
+export type InterviewsControllerListResponse = InterviewsControllerListResponses[keyof InterviewsControllerListResponses];
+export type InterviewsControllerCreateData = {
+    /**
+     * CreateInterviewSchema
+     *
+     * Schema for creating an interview. When invitees is provided, one invitation is created (and sent) per invitee. Otherwise a single initial invitation is created, pre-filled with email/phone when given. When locale or voiceId is omitted, the organization default (Settings > Interviews) is used, falling back to the app default language and the first voice for that language.
+     */
+    body: {
+        prompt: string;
+        title?: string;
+        intro?: string;
+        firstMessage?: string;
+        email?: string;
+        phone?: string;
+        invitees?: Array<{
+            name?: string;
+            email?: string;
+            phone?: string;
+        }>;
+        locale?: string;
+        voiceId?: string;
+    };
+    path?: never;
+    query?: never;
+    url: "/api/interviews";
+};
+export type InterviewsControllerCreateResponses = {
+    /**
+     * Response for interview creation
+     */
+    200: CreatedInterviewsResponse;
+};
+export type InterviewsControllerCreateResponse = InterviewsControllerCreateResponses[keyof InterviewsControllerCreateResponses];
+export type InterviewsControllerGetOneData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}";
+};
+export type InterviewsControllerGetOneResponses = {
+    /**
+     * Schema for an interview definition. invitations is the list of recipients this interview has been (or will be) sent to. When invitationsCount == 1, the interview is in "single" mode; when > 1, it is a bulk send.
+     */
+    200: InterviewSchema;
+};
+export type InterviewsControllerGetOneResponse = InterviewsControllerGetOneResponses[keyof InterviewsControllerGetOneResponses];
+export type InterviewsControllerUpdateData = {
+    /**
+     * UpdateInterviewSchema
+     *
+     * Schema for updating an interview definition. Recipient fields live on invitations and are updated via the invitations endpoints.
+     */
+    body: {
+        title?: string;
+        prompt?: string;
+        intro?: string;
+        firstMessage?: string;
+        locale?: string;
+        maxMinutes?: number;
+        maxResponses?: number;
+        disableOrgSystemPrompt?: boolean;
+        voiceId?: string;
+    };
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}";
+};
+export type InterviewsControllerUpdateResponses = {
+    /**
+     * Schema for an interview definition. invitations is the list of recipients this interview has been (or will be) sent to. When invitationsCount == 1, the interview is in "single" mode; when > 1, it is a bulk send.
+     */
+    200: InterviewSchema;
+};
+export type InterviewsControllerUpdateResponse = InterviewsControllerUpdateResponses[keyof InterviewsControllerUpdateResponses];
+export type InterviewsControllerRegenerateIntroData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/regenerate-intro";
+};
+export type InterviewsControllerRegenerateIntroResponses = {
+    /**
+     * Schema for an interview definition. invitations is the list of recipients this interview has been (or will be) sent to. When invitationsCount == 1, the interview is in "single" mode; when > 1, it is a bulk send.
+     */
+    200: InterviewSchema;
+};
+export type InterviewsControllerRegenerateIntroResponse = InterviewsControllerRegenerateIntroResponses[keyof InterviewsControllerRegenerateIntroResponses];
+export type InterviewsControllerRegenerateFirstMessageData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/regenerate-first-message";
+};
+export type InterviewsControllerRegenerateFirstMessageResponses = {
+    /**
+     * Schema for an interview definition. invitations is the list of recipients this interview has been (or will be) sent to. When invitationsCount == 1, the interview is in "single" mode; when > 1, it is a bulk send.
+     */
+    200: InterviewSchema;
+};
+export type InterviewsControllerRegenerateFirstMessageResponse = InterviewsControllerRegenerateFirstMessageResponses[keyof InterviewsControllerRegenerateFirstMessageResponses];
+export type InterviewsControllerArchiveData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/archive";
+};
+export type InterviewsControllerArchiveResponses = {
+    /**
+     * Response for archiving an interview
+     */
+    200: ArchiveInterviewResponse;
+};
+export type InterviewsControllerArchiveResponse = InterviewsControllerArchiveResponses[keyof InterviewsControllerArchiveResponses];
+export type InterviewsControllerRestoreData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/restore";
+};
+export type InterviewsControllerRestoreResponses = {
+    /**
+     * Response for restoring an archived interview
+     */
+    200: RestoreInterviewResponse;
+};
+export type InterviewsControllerRestoreResponse = InterviewsControllerRestoreResponses[keyof InterviewsControllerRestoreResponses];
+export type InterviewsControllerGetLogsData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/logs";
+};
+export type InterviewsControllerGetLogsResponses = {
+    /**
+     * Chronological history of events on an interview, most recent first.
+     */
+    200: InterviewLogListSchema;
+};
+export type InterviewsControllerGetLogsResponse = InterviewsControllerGetLogsResponses[keyof InterviewsControllerGetLogsResponses];
+export type InterviewInvitationsControllerListData = {
+    body?: never;
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/invitations";
+};
+export type InterviewInvitationsControllerListResponses = {
+    /**
+     * List of interview invitations belonging to an interview.
+     */
+    200: InterviewInvitationListSchema;
+};
+export type InterviewInvitationsControllerListResponse = InterviewInvitationsControllerListResponses[keyof InterviewInvitationsControllerListResponses];
+export type InterviewInvitationsControllerCreateData = {
+    /**
+     * CreateInterviewInvitationSchema
+     *
+     * Optional invitee details for a new invitation. Every field is optional: with an empty body you get a blank, ready-to-share invitation whose link is `<app>/invitation/{slug}` (the `slug` is returned in the response). Providing name, email or phone only pre-fills the invitation, it is not sent here: deliver it with the send endpoint, or just share the link.
+     */
+    body: {
+        name?: string;
+        email?: string;
+        phone?: string;
+    };
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/invitations";
+};
+export type InterviewInvitationsControllerCreateResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerCreateResponse = InterviewInvitationsControllerCreateResponses[keyof InterviewInvitationsControllerCreateResponses];
+export type InterviewInvitationsControllerCreateBulkData = {
+    /**
+     * CreateBulkInterviewInvitationsSchema
+     *
+     * Bulk create N interview invitations on an existing interview and dispatch each one by email or SMS right away. Each invitee row must carry an email or a phone.
+     */
+    body: {
+        invitees: Array<{
+            name?: string;
+            email?: string;
+            phone?: string;
+        }>;
+    };
+    path: {
+        /**
+         * UUID identifier
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/interviews/{id}/invitations/bulk";
+};
+export type InterviewInvitationsControllerCreateBulkResponses = {
+    /**
+     * List of interview invitations belonging to an interview.
+     */
+    200: InterviewInvitationListSchema;
+};
+export type InterviewInvitationsControllerCreateBulkResponse = InterviewInvitationsControllerCreateBulkResponses[keyof InterviewInvitationsControllerCreateBulkResponses];
+export type InterviewInvitationsControllerGetOneData = {
+    body?: never;
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}";
+};
+export type InterviewInvitationsControllerGetOneResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerGetOneResponse = InterviewInvitationsControllerGetOneResponses[keyof InterviewInvitationsControllerGetOneResponses];
+export type InterviewInvitationsControllerUpdateData = {
+    /**
+     * UpdateInterviewInvitationSchema
+     *
+     * Schema for updating the invitee display name on an interview invitation. The recipient email and phone cannot be changed here: they are set when sending (see the send endpoint), so contact details are never altered without dispatching the invitation.
+     */
+    body: {
+        name?: string | null;
+    };
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}";
+};
+export type InterviewInvitationsControllerUpdateResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerUpdateResponse = InterviewInvitationsControllerUpdateResponses[keyof InterviewInvitationsControllerUpdateResponses];
+export type InterviewInvitationsControllerSendData = {
+    /**
+     * SendInterviewInvitationSchema
+     *
+     * Schema for sending an interview invitation by email or SMS. At least one of email or phone must be provided.
+     */
+    body: {
+        email?: string;
+        phone?: string;
+    };
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/send";
+};
+export type InterviewInvitationsControllerSendResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerSendResponse = InterviewInvitationsControllerSendResponses[keyof InterviewInvitationsControllerSendResponses];
+export type InterviewInvitationsControllerCancelData = {
+    body?: never;
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/cancel";
+};
+export type InterviewInvitationsControllerCancelResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerCancelResponse = InterviewInvitationsControllerCancelResponses[keyof InterviewInvitationsControllerCancelResponses];
+export type InterviewInvitationsControllerReactivateData = {
+    body?: never;
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/reactivate";
+};
+export type InterviewInvitationsControllerReactivateResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerReactivateResponse = InterviewInvitationsControllerReactivateResponses[keyof InterviewInvitationsControllerReactivateResponses];
+export type InterviewInvitationsControllerArchiveData = {
+    body?: never;
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/archive";
+};
+export type InterviewInvitationsControllerArchiveResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerArchiveResponse = InterviewInvitationsControllerArchiveResponses[keyof InterviewInvitationsControllerArchiveResponses];
+export type InterviewInvitationsControllerRestoreData = {
+    body?: never;
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/restore";
+};
+export type InterviewInvitationsControllerRestoreResponses = {
+    /**
+     * Full interview invitation payload including transcript messages. summary and per-message sentiments are populated asynchronously once the invitation reaches the completed state.
+     */
+    200: InterviewInvitationSchema;
+};
+export type InterviewInvitationsControllerRestoreResponse = InterviewInvitationsControllerRestoreResponses[keyof InterviewInvitationsControllerRestoreResponses];
+export type InterviewInvitationsControllerGetLogsData = {
+    body?: never;
+    path: {
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/logs";
+};
+export type InterviewInvitationsControllerGetLogsResponses = {
+    /**
+     * Chronological history of events on an interview, most recent first.
+     */
+    200: InterviewLogListSchema;
+};
+export type InterviewInvitationsControllerGetLogsResponse = InterviewInvitationsControllerGetLogsResponses[keyof InterviewInvitationsControllerGetLogsResponses];
+export type InterviewInvitationsControllerGetMessageAudioUrlData = {
+    body?: never;
+    path: {
+        /**
+         * Interview message UUID
+         */
+        messageId: string;
+        /**
+         * Interview invitation UUID
+         */
+        invitationId: string;
+    };
+    query?: never;
+    url: "/api/invitations/{invitationId}/messages/{messageId}/audio-url";
+};
+export type InterviewInvitationsControllerGetMessageAudioUrlResponses = {
+    /**
+     * Short-lived presigned URL for the audio attached to an interview message.
+     */
+    200: InterviewMessageAudioUrlSchema;
+};
+export type InterviewInvitationsControllerGetMessageAudioUrlResponse = InterviewInvitationsControllerGetMessageAudioUrlResponses[keyof InterviewInvitationsControllerGetMessageAudioUrlResponses];
+export type VoicesControllerListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * ISO 639-1 code to filter voices by. Voices flagged as "all" are always included.
+         */
+        language?: string;
+    };
+    url: "/api/voices";
+};
+export type VoicesControllerListResponses = {
+    /**
+     * List of voices matching the requested language filter.
+     */
+    200: VoiceListSchema;
+};
+export type VoicesControllerListResponse = VoicesControllerListResponses[keyof VoicesControllerListResponses];
+export type VoicesControllerGetTestAudioUrlData = {
+    body?: never;
+    path: {
+        /**
+         * Voice UUID
+         */
+        id: string;
+    };
+    query?: never;
+    url: "/api/voices/{id}/test-audio-url";
+};
+export type VoicesControllerGetTestAudioUrlResponses = {
+    /**
+     * Short-lived presigned URL for the voice preview audio. Generated on first request if missing.
+     */
+    200: VoiceTestAudioUrlSchema;
+};
+export type VoicesControllerGetTestAudioUrlResponse = VoicesControllerGetTestAudioUrlResponses[keyof VoicesControllerGetTestAudioUrlResponses];