@japro/luma-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,349 @@
+import { AxiosInstance, AxiosRequestConfig, ResponseType, AxiosResponse } from 'axios';
+import { Agent } from 'node:https';
+
+/** ArchitectAiMentorLesson */
+interface ArchitectAiMentorLesson {
+    /** Name */
+    name: string;
+    /** Aimentorinstructions */
+    aiMentorInstructions: string;
+    /** Completionconditions */
+    completionConditions: string;
+    /** Type */
+    type: "ROLEPLAY" | "MENTOR" | "TEACHER";
+    /** Taskdescription */
+    taskDescription: string;
+}
+/** ArchitectChapter */
+interface ArchitectChapter {
+    /** Chapterindex */
+    chapterIndex: number;
+    /** Title */
+    title: string;
+    /** Lessons */
+    lessons: ArchitectLesson[];
+}
+/** ArchitectCourseResponse */
+interface ArchitectCourseResponse {
+    /** Title */
+    title: string;
+    /** Description */
+    description: string;
+    /** Chapters */
+    chapters: ArchitectChapter[];
+}
+/** ArchitectLesson */
+interface ArchitectLesson {
+    /** Lessontype */
+    lessonType: "AI_MENTOR" | "CONTENT" | "QUIZ";
+    /** Title */
+    title: string;
+    /** Content */
+    content: string | null;
+    /** Questions */
+    questions: ArchitectQuizQuestion[] | null;
+    aiMentor: ArchitectAiMentorLesson | null;
+}
+/** ArchitectQuizOption */
+interface ArchitectQuizOption {
+    /** Optionindex */
+    optionIndex: number;
+    /** Optiontext */
+    optionText: string;
+    /** Iscorrect */
+    isCorrect: boolean;
+}
+/** ArchitectQuizQuestion */
+interface ArchitectQuizQuestion {
+    /** Questionindex */
+    questionIndex: number;
+    /** Type */
+    type: "SingleSelect" | "MultiSelect" | "TrueOrFalse" | "BriefResponse" | "DetailedResponse" | "FillInTheBlanks" | "GapFill";
+    /** Title */
+    title: string;
+    /** Description */
+    description: string | null;
+    /** Solutionexplanation */
+    solutionExplanation: string | null;
+    /** Options */
+    options: ArchitectQuizOption[] | null;
+}
+/** Body_ingest_api_public_v1_draft_ingest__integration_id__post */
+interface BodyIngestApiPublicV1DraftIngestIntegrationIdPost {
+    /**
+     * File
+     * @format binary
+     */
+    file: File;
+}
+/** CreateDraft */
+interface CreateDraft {
+    /**
+     * Integrationid
+     * @format uuid
+     */
+    integrationId: string;
+    /** Draftname */
+    draftName: string;
+}
+/** CreateDraftResponse */
+interface CreateDraftResponse {
+    /**
+     * Draftid
+     * @format uuid
+     */
+    draftId: string;
+}
+/** DeleteIngestedDocumentResponse */
+interface DeleteIngestedDocumentResponse {
+    /** Message */
+    message: string;
+}
+/** DraftFilesResponseBody */
+interface DraftFilesResponseBody {
+    /**
+     * Id
+     * @format uuid
+     */
+    id: string;
+    /** Filename */
+    filename: string;
+    /** Contenttype */
+    contentType: string;
+}
+/** DraftMessageResponse */
+interface DraftMessageResponse {
+    /**
+     * Id
+     * @format uuid
+     */
+    id: string;
+    /**
+     * Draftid
+     * @format uuid
+     */
+    draftId: string;
+    /** Role */
+    role: string;
+    /** Content */
+    content: string;
+    /** Contenttype */
+    contentType: string;
+    /** Draftmetadata */
+    draftMetadata?: Record<string, any> | null;
+    /**
+     * Createdat
+     * @format date-time
+     */
+    createdAt: string;
+    /**
+     * Updatedat
+     * @format date-time
+     */
+    updatedAt: string;
+}
+/** GetDraftResponse */
+interface GetDraftResponse {
+    /**
+     * Draftid
+     * @format uuid
+     */
+    draftId: string;
+    /** Iscoursegenerated */
+    isCourseGenerated: boolean;
+}
+/** IngestDraftResponse */
+interface IngestDraftResponse {
+    /** Success */
+    success: boolean;
+    /** Queued */
+    queued: boolean;
+    /** Jobid */
+    jobId?: string | null;
+}
+/** Message */
+interface Message {
+    /** Message */
+    message: string;
+}
+type QueryParamsType = Record<string | number, any>;
+interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+    /** set parameter to `true` for call `securityWorker` for this request */
+    secure?: boolean;
+    /** request path */
+    path: string;
+    /** content type of request body */
+    type?: ContentType;
+    /** query params */
+    query?: QueryParamsType;
+    /** format of response (i.e. response.json() -> format: "json") */
+    format?: ResponseType;
+    /** request body */
+    body?: unknown;
+}
+type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+    secure?: boolean;
+    format?: ResponseType;
+}
+declare enum ContentType {
+    Json = "application/json",
+    JsonApi = "application/vnd.api+json",
+    FormData = "multipart/form-data",
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
+}
+declare class HttpClient<SecurityDataType = unknown> {
+    instance: AxiosInstance;
+    private securityData;
+    private securityWorker?;
+    private secure?;
+    private format?;
+    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
+    setSecurityData: (data: SecurityDataType | null) => void;
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
+    protected stringifyFormItem(formItem: unknown): string;
+    protected createFormData(input: Record<string, unknown>): FormData;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
+}
+/**
+ * @title Luma API
+ * @version 0.1.0
+ */
+declare class API<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
+    api: {
+        /**
+         * @description Streams AI chat responses for the draft associated with `integration_id` (the external course identifier you are building a draft for), scoped to the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name ChatApiPublicV1AiChatIntegrationIdPost
+         * @summary Chat With Draft By Integration ID
+         * @request POST:/api/public/v1/ai/chat/{integration_id}
+         * @secure
+         */
+        chatApiPublicV1AiChatIntegrationIdPost: (integrationId: string, data: Message, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Creates a draft for a given `integration_id` (the external course identifier you are building a draft for) under the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name CreateDraftApiPublicV1DraftPost
+         * @summary Create Draft By Integration ID
+         * @request POST:/api/public/v1/draft
+         * @secure
+         */
+        createDraftApiPublicV1DraftPost: (data: CreateDraft, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Uploads a file to the draft associated with `integration_id` (the external course identifier you are building a draft for), scoped to the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name IngestApiPublicV1DraftIngestIntegrationIdPost
+         * @summary Ingest File To Draft By Integration ID
+         * @request POST:/api/public/v1/draft/ingest/{integration_id}
+         * @secure
+         */
+        ingestApiPublicV1DraftIngestIntegrationIdPost: (integrationId: string, data: BodyIngestApiPublicV1DraftIngestIntegrationIdPost, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Removes a previously ingested document from the draft associated with `integration_id` (the external course identifier you are building a draft for), scoped to the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name DeleteIngestedDocumentApiPublicV1DraftIngestIntegrationIdDocumentIdDelete
+         * @summary Delete Ingested Document By Integration ID
+         * @request DELETE:/api/public/v1/draft/ingest/{integration_id}/{document_id}
+         * @secure
+         */
+        deleteIngestedDocumentApiPublicV1DraftIngestIntegrationIdDocumentIdDelete: (integrationId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Returns all files linked to the draft for the provided `integration_id` (the external course identifier you are building a draft for), scoped to the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name GetDraftFilesApiPublicV1DraftFilesIntegrationIdGet
+         * @summary Get Draft Files By Integration ID
+         * @request GET:/api/public/v1/draft/files/{integration_id}
+         * @secure
+         */
+        getDraftFilesApiPublicV1DraftFilesIntegrationIdGet: (integrationId: string, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Fetches draft status for the provided `integration_id` (the external course identifier you are building a draft for) inside the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name GetDraftApiPublicV1DraftIntegrationIdGet
+         * @summary Get Draft Status By Integration ID
+         * @request GET:/api/public/v1/draft/{integration_id}
+         * @secure
+         */
+        getDraftApiPublicV1DraftIntegrationIdGet: (integrationId: string, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Returns all draft chat messages for the draft associated with `integration_id` (the external course identifier you are building a draft for), scoped to the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name GetDraftMessagesApiPublicV1DraftMessagesIntegrationIdGet
+         * @summary Get Draft Messages By Integration ID
+         * @request GET:/api/public/v1/draft/messages/{integration_id}
+         * @secure
+         */
+        getDraftMessagesApiPublicV1DraftMessagesIntegrationIdGet: (integrationId: string, params?: RequestParams) => Promise<AxiosResponse<T>>;
+        /**
+         * @description Returns the generated course payload for the draft associated with `integration_id` (the external course identifier you are building a draft for), scoped to the organization resolved from `X-API-Key`. Authorization header required: `X-API-Key: <luma_api_key>`.
+         *
+         * @tags Public - Require API Key
+         * @name GetGeneratedCourseApiPublicV1DraftGeneratedCourseIntegrationIdGet
+         * @summary Get Generated Course By Integration ID
+         * @request GET:/api/public/v1/draft/generated-course/{integration_id}
+         * @secure
+         */
+        getGeneratedCourseApiPublicV1DraftGeneratedCourseIntegrationIdGet: (integrationId: string, params?: RequestParams) => Promise<AxiosResponse<T>>;
+    };
+}
+
+type IntegrationIdOptions = {
+    integrationId: string;
+};
+type ChatOptions = IntegrationIdOptions & Message;
+type CreateDraftOptions = CreateDraft;
+type DraftFile = DraftFilesResponseBody;
+type DraftFilesResponse = DraftFile[];
+type DraftMessage = DraftMessageResponse;
+type DraftMessagesResponse = DraftMessage[];
+type GeneratedCourseResponse = ArchitectCourseResponse;
+type IngestDraftFileOptions = IntegrationIdOptions & BodyIngestApiPublicV1DraftIngestIntegrationIdPost;
+type DeleteIngestedDocumentOptions = IntegrationIdOptions & {
+    documentId: string;
+};
+
+declare class PublicApiExecutions {
+    private readonly apiClient;
+    constructor(apiClient: API<unknown>);
+    chat(opts: ChatOptions): ReturnType<API<unknown>["api"]["chatApiPublicV1AiChatIntegrationIdPost"]>;
+    createDraft(opts: CreateDraftOptions): Promise<CreateDraftResponse>;
+    ingestDraftFile(opts: IngestDraftFileOptions): Promise<IngestDraftResponse>;
+    deleteIngestedDocument(opts: DeleteIngestedDocumentOptions): Promise<DeleteIngestedDocumentResponse>;
+    getDraftFiles(opts: IntegrationIdOptions): Promise<DraftFilesResponse>;
+    getDraft(opts: IntegrationIdOptions): Promise<GetDraftResponse>;
+    getDraftMessages(opts: IntegrationIdOptions): Promise<DraftMessagesResponse>;
+    getGeneratedCourse(opts: IntegrationIdOptions): Promise<GeneratedCourseResponse>;
+}
+
+type LumaClientOptions = {
+    baseURL?: string;
+    apiKey?: string;
+    httpsAgent?: Agent;
+    allowInsecureTls?: boolean;
+};
+declare class LumaClient {
+    apiClient: API<unknown>;
+    private readonly executions;
+    constructor(opts: LumaClientOptions);
+    chat(opts: ChatOptions): ReturnType<PublicApiExecutions["chat"]>;
+    createDraft(opts: CreateDraftOptions): Promise<CreateDraftResponse>;
+    ingestDraftFile(opts: IngestDraftFileOptions): Promise<IngestDraftResponse>;
+    deleteIngestedDocument(opts: DeleteIngestedDocumentOptions): Promise<DeleteIngestedDocumentResponse>;
+    getDraftFiles(opts: IntegrationIdOptions): Promise<DraftFilesResponse>;
+    getDraft(opts: IntegrationIdOptions): Promise<GetDraftResponse>;
+    getDraftMessages(opts: IntegrationIdOptions): Promise<DraftMessagesResponse>;
+    getGeneratedCourse(opts: IntegrationIdOptions): Promise<GeneratedCourseResponse>;
+}
+
+declare const createLumaClient: (opts: LumaClientOptions) => LumaClient;
+
+export { type ChatOptions, type CreateDraftOptions, type CreateDraftResponse, type DeleteIngestedDocumentOptions, type DeleteIngestedDocumentResponse, type DraftFile, type DraftFilesResponse, type DraftMessage, type DraftMessagesResponse, type GeneratedCourseResponse, type GetDraftResponse, type IngestDraftFileOptions, type IngestDraftResponse as IngestDraftFileResponse, type IntegrationIdOptions, LumaClient, type LumaClientOptions, createLumaClient };