@examplary/sdk 2.4.0 → 2.5.0

package/dist/index.d.mts

@@ -1031,6 +1031,46 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/audit-logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List audit logs
+         * @description List the workspace's audit logs, newest first, with optional date range, actor and object filters. Paginated.
+         */
+        get: operations["audit-logs.list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/audit-logs/export": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Export audit logs
+         * @description Export audit logs for a date range (optionally filtered by actor/object) as ND-JSON. Returns a temporary download URL.
+         */
+        get: operations["audit-logs.export"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api-keys": {
         parameters: {
             query?: never;
@@ -1947,6 +1987,54 @@ interface paths {
         patch: operations["patchRubrics:id"];
         trace?: never;
     };
+    "/prompts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get prompts
+         * @description Get a list of reusable prompts, merging the workspace's saved prompts with the defaults provided by Examplary. Optionally filter by type and language.
+         */
+        get: operations["prompts.list"];
+        put?: never;
+        /**
+         * Save prompt
+         * @description Save a reusable prompt in the current workspace.
+         */
+        post: operations["prompts.create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/prompts/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Delete prompt
+         * @description Delete a prompt from the current workspace.
+         */
+        delete: operations["prompts.delete"];
+        options?: never;
+        head?: never;
+        /**
+         * Update prompt
+         * @description Update an existing prompt in the current workspace.
+         */
+        patch: operations["prompts.update"];
+        trace?: never;
+    };
     "/jobs/{id}": {
         parameters: {
             query?: never;
@@ -3660,11 +3748,9 @@ interface operations {
             content: {
                 "application/json": {
                     name?: string;
-                    /** Format: uri */
                     logoImageUrl?: string;
                     menuColor?: string;
                     accentColor?: string;
-                    sharingBlockPublic?: boolean;
                     settings?: {
                         /** @description Whether users can only see other users in the same groups as them. */
                         restrictGroupVisibility?: boolean;
@@ -3730,6 +3816,42 @@ interface operations {
         };
         responses: never;
     };
+    "audit-logs.list": {
+        parameters: {
+            query?: {
+                actor?: string;
+                object?: string;
+                /** @description Start date (YYYY-MM-DD), inclusive */
+                from?: string;
+                /** @description End date (YYYY-MM-DD), inclusive */
+                to?: string;
+                /** @description Base64-encoded pagination cursor */
+                exclusiveStartKey?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "audit-logs.export": {
+        parameters: {
+            query: {
+                /** @description Start date (YYYY-MM-DD), inclusive */
+                from: string;
+                /** @description End date (YYYY-MM-DD), inclusive */
+                to: string;
+                actor?: string;
+                object?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "apiKeys.get": {
         parameters: {
             query?: never;
@@ -5642,6 +5764,71 @@ interface operations {
         };
         responses: never;
     };
+    "prompts.list": {
+        parameters: {
+            query?: {
+                /** @description Only return prompts of this type */
+                type?: string;
+                /** @description Language for the default prompts, falls back to the user's preference or 'en' */
+                language?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "prompts.create": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    name: string;
+                    promptType: string;
+                    content: string;
+                };
+            };
+        };
+        responses: never;
+    };
+    "prompts.delete": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "prompts.update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    name?: string;
+                    promptType?: string;
+                    content?: string;
+                };
+            };
+        };
+        responses: never;
+    };
     "jobs.get": {
         parameters: {
             query?: never;
@@ -5958,6 +6145,12 @@ interface _PathOverrides {
     "deleteRubrics:id": {
         id: string;
     };
+    "prompts.update": {
+        id: string;
+    };
+    "prompts.delete": {
+        id: string;
+    };
     "jobs.get": {
         id: string;
     };
@@ -6614,6 +6807,26 @@ declare class Orgs {
      */
     create(args?: Args<"orgs.create">, options?: ExamplaryRequestOptions): Promise<Response<"orgs.create">>;
 }
+declare class AuditLogs {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * List audit logs
+     *
+     * List the workspace's audit logs, newest first, with optional date range, actor and object filters. Paginated.
+     *
+     * API endpoint: `GET /audit-logs`
+     */
+    list(args?: Args<"audit-logs.list">, options?: ExamplaryRequestOptions): Promise<Response<"audit-logs.list">>;
+    /**
+     * Export audit logs
+     *
+     * Export audit logs for a date range (optionally filtered by actor/object) as ND-JSON. Returns a temporary download URL.
+     *
+     * API endpoint: `GET /audit-logs/export`
+     */
+    export(args: Args<"audit-logs.export">, options?: ExamplaryRequestOptions): Promise<Response<"audit-logs.export">>;
+}
 declare class ApiKeys {
     private readonly ctx;
     constructor(ctx: ClientContext);
@@ -7167,6 +7380,43 @@ declare class QuestionBank {
     delete(id: string, options?: ExamplaryRequestOptions): Promise<Response<"questionBank.delete">>;
     delete(args: Args<"questionBank.delete">, options?: ExamplaryRequestOptions): Promise<Response<"questionBank.delete">>;
 }
+declare class Prompts {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * Get prompts
+     *
+     * Get a list of reusable prompts, merging the workspace's saved prompts with the defaults provided by Examplary. Optionally filter by type and language.
+     *
+     * API endpoint: `GET /prompts`
+     */
+    list(args?: Args<"prompts.list">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.list">>;
+    /**
+     * Save prompt
+     *
+     * Save a reusable prompt in the current workspace.
+     *
+     * API endpoint: `POST /prompts`
+     */
+    create(args?: Args<"prompts.create">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.create">>;
+    /**
+     * Update prompt
+     *
+     * Update an existing prompt in the current workspace.
+     *
+     * API endpoint: `PATCH /prompts/{id}`
+     */
+    update(args: Args<"prompts.update">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.update">>;
+    /**
+     * Delete prompt
+     *
+     * Delete a prompt from the current workspace.
+     *
+     * API endpoint: `DELETE /prompts/{id}`
+     */
+    delete(id: string, options?: ExamplaryRequestOptions): Promise<Response<"prompts.delete">>;
+    delete(args: Args<"prompts.delete">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.delete">>;
+}
 declare class Jobs {
     private readonly ctx;
     constructor(ctx: ClientContext);
@@ -7200,6 +7450,7 @@ declare class Examplary {
     readonly media: Media;
     readonly org: Org;
     readonly orgs: Orgs;
+    readonly auditLogs: AuditLogs;
     readonly apiKeys: ApiKeys;
     readonly attributes: Attributes;
     readonly taxonomies: Taxonomies;
@@ -7211,6 +7462,7 @@ declare class Examplary {
     readonly folders: Folders;
     readonly groups: Groups;
     readonly questionBank: QuestionBank;
+    readonly prompts: Prompts;
     readonly jobs: Jobs;
     constructor(options: ExamplaryClientOptions);
     /**

package/dist/index.d.ts

@@ -1031,6 +1031,46 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/audit-logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List audit logs
+         * @description List the workspace's audit logs, newest first, with optional date range, actor and object filters. Paginated.
+         */
+        get: operations["audit-logs.list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/audit-logs/export": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Export audit logs
+         * @description Export audit logs for a date range (optionally filtered by actor/object) as ND-JSON. Returns a temporary download URL.
+         */
+        get: operations["audit-logs.export"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api-keys": {
         parameters: {
             query?: never;
@@ -1947,6 +1987,54 @@ interface paths {
         patch: operations["patchRubrics:id"];
         trace?: never;
     };
+    "/prompts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get prompts
+         * @description Get a list of reusable prompts, merging the workspace's saved prompts with the defaults provided by Examplary. Optionally filter by type and language.
+         */
+        get: operations["prompts.list"];
+        put?: never;
+        /**
+         * Save prompt
+         * @description Save a reusable prompt in the current workspace.
+         */
+        post: operations["prompts.create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/prompts/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Delete prompt
+         * @description Delete a prompt from the current workspace.
+         */
+        delete: operations["prompts.delete"];
+        options?: never;
+        head?: never;
+        /**
+         * Update prompt
+         * @description Update an existing prompt in the current workspace.
+         */
+        patch: operations["prompts.update"];
+        trace?: never;
+    };
     "/jobs/{id}": {
         parameters: {
             query?: never;
@@ -3660,11 +3748,9 @@ interface operations {
             content: {
                 "application/json": {
                     name?: string;
-                    /** Format: uri */
                     logoImageUrl?: string;
                     menuColor?: string;
                     accentColor?: string;
-                    sharingBlockPublic?: boolean;
                     settings?: {
                         /** @description Whether users can only see other users in the same groups as them. */
                         restrictGroupVisibility?: boolean;
@@ -3730,6 +3816,42 @@ interface operations {
         };
         responses: never;
     };
+    "audit-logs.list": {
+        parameters: {
+            query?: {
+                actor?: string;
+                object?: string;
+                /** @description Start date (YYYY-MM-DD), inclusive */
+                from?: string;
+                /** @description End date (YYYY-MM-DD), inclusive */
+                to?: string;
+                /** @description Base64-encoded pagination cursor */
+                exclusiveStartKey?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "audit-logs.export": {
+        parameters: {
+            query: {
+                /** @description Start date (YYYY-MM-DD), inclusive */
+                from: string;
+                /** @description End date (YYYY-MM-DD), inclusive */
+                to: string;
+                actor?: string;
+                object?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "apiKeys.get": {
         parameters: {
             query?: never;
@@ -5642,6 +5764,71 @@ interface operations {
         };
         responses: never;
     };
+    "prompts.list": {
+        parameters: {
+            query?: {
+                /** @description Only return prompts of this type */
+                type?: string;
+                /** @description Language for the default prompts, falls back to the user's preference or 'en' */
+                language?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "prompts.create": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    name: string;
+                    promptType: string;
+                    content: string;
+                };
+            };
+        };
+        responses: never;
+    };
+    "prompts.delete": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "prompts.update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    name?: string;
+                    promptType?: string;
+                    content?: string;
+                };
+            };
+        };
+        responses: never;
+    };
     "jobs.get": {
         parameters: {
             query?: never;
@@ -5958,6 +6145,12 @@ interface _PathOverrides {
     "deleteRubrics:id": {
         id: string;
     };
+    "prompts.update": {
+        id: string;
+    };
+    "prompts.delete": {
+        id: string;
+    };
     "jobs.get": {
         id: string;
     };
@@ -6614,6 +6807,26 @@ declare class Orgs {
      */
     create(args?: Args<"orgs.create">, options?: ExamplaryRequestOptions): Promise<Response<"orgs.create">>;
 }
+declare class AuditLogs {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * List audit logs
+     *
+     * List the workspace's audit logs, newest first, with optional date range, actor and object filters. Paginated.
+     *
+     * API endpoint: `GET /audit-logs`
+     */
+    list(args?: Args<"audit-logs.list">, options?: ExamplaryRequestOptions): Promise<Response<"audit-logs.list">>;
+    /**
+     * Export audit logs
+     *
+     * Export audit logs for a date range (optionally filtered by actor/object) as ND-JSON. Returns a temporary download URL.
+     *
+     * API endpoint: `GET /audit-logs/export`
+     */
+    export(args: Args<"audit-logs.export">, options?: ExamplaryRequestOptions): Promise<Response<"audit-logs.export">>;
+}
 declare class ApiKeys {
     private readonly ctx;
     constructor(ctx: ClientContext);
@@ -7167,6 +7380,43 @@ declare class QuestionBank {
     delete(id: string, options?: ExamplaryRequestOptions): Promise<Response<"questionBank.delete">>;
     delete(args: Args<"questionBank.delete">, options?: ExamplaryRequestOptions): Promise<Response<"questionBank.delete">>;
 }
+declare class Prompts {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * Get prompts
+     *
+     * Get a list of reusable prompts, merging the workspace's saved prompts with the defaults provided by Examplary. Optionally filter by type and language.
+     *
+     * API endpoint: `GET /prompts`
+     */
+    list(args?: Args<"prompts.list">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.list">>;
+    /**
+     * Save prompt
+     *
+     * Save a reusable prompt in the current workspace.
+     *
+     * API endpoint: `POST /prompts`
+     */
+    create(args?: Args<"prompts.create">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.create">>;
+    /**
+     * Update prompt
+     *
+     * Update an existing prompt in the current workspace.
+     *
+     * API endpoint: `PATCH /prompts/{id}`
+     */
+    update(args: Args<"prompts.update">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.update">>;
+    /**
+     * Delete prompt
+     *
+     * Delete a prompt from the current workspace.
+     *
+     * API endpoint: `DELETE /prompts/{id}`
+     */
+    delete(id: string, options?: ExamplaryRequestOptions): Promise<Response<"prompts.delete">>;
+    delete(args: Args<"prompts.delete">, options?: ExamplaryRequestOptions): Promise<Response<"prompts.delete">>;
+}
 declare class Jobs {
     private readonly ctx;
     constructor(ctx: ClientContext);
@@ -7200,6 +7450,7 @@ declare class Examplary {
     readonly media: Media;
     readonly org: Org;
     readonly orgs: Orgs;
+    readonly auditLogs: AuditLogs;
     readonly apiKeys: ApiKeys;
     readonly attributes: Attributes;
     readonly taxonomies: Taxonomies;
@@ -7211,6 +7462,7 @@ declare class Examplary {
     readonly folders: Folders;
     readonly groups: Groups;
     readonly questionBank: QuestionBank;
+    readonly prompts: Prompts;
     readonly jobs: Jobs;
     constructor(options: ExamplaryClientOptions);
     /**

package/dist/index.js

@@ -521,6 +521,19 @@ var Orgs = class {
     return request(this.ctx, "POST", "/orgs", [], [], true, args, options);
   }
 };
+var AuditLogs = class {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  list(arg, options) {
+    const args = arg;
+    return request(this.ctx, "GET", "/audit-logs", [], ["actor", "object", "from", "to", "exclusiveStartKey"], false, args, options);
+  }
+  export(arg, options) {
+    const args = arg;
+    return request(this.ctx, "GET", "/audit-logs/export", [], ["from", "to", "actor", "object"], false, args, options);
+  }
+};
 var ApiKeys = class {
   constructor(ctx) {
     this.ctx = ctx;
@@ -828,6 +841,27 @@ var QuestionBank = class {
     return request(this.ctx, "DELETE", "/question-bank/{id}", ["id"], [], false, args, options);
   }
 };
+var Prompts = class {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  list(arg, options) {
+    const args = arg;
+    return request(this.ctx, "GET", "/prompts", [], ["type", "language"], false, args, options);
+  }
+  create(arg, options) {
+    const args = arg;
+    return request(this.ctx, "POST", "/prompts", [], [], true, args, options);
+  }
+  update(arg, options) {
+    const args = arg;
+    return request(this.ctx, "PATCH", "/prompts/{id}", ["id"], [], true, args, options);
+  }
+  delete(arg, options) {
+    const args = typeof arg === "string" ? { id: arg } : arg;
+    return request(this.ctx, "DELETE", "/prompts/{id}", ["id"], [], false, args, options);
+  }
+};
 var Jobs = class {
   constructor(ctx) {
     this.ctx = ctx;
@@ -853,6 +887,7 @@ var Examplary = class {
     this.media = new Media(this.ctx);
     this.org = new Org(this.ctx);
     this.orgs = new Orgs(this.ctx);
+    this.auditLogs = new AuditLogs(this.ctx);
     this.apiKeys = new ApiKeys(this.ctx);
     this.attributes = new Attributes(this.ctx);
     this.taxonomies = new Taxonomies(this.ctx);
@@ -864,6 +899,7 @@ var Examplary = class {
     this.folders = new Folders(this.ctx);
     this.groups = new Groups(this.ctx);
     this.questionBank = new QuestionBank(this.ctx);
+    this.prompts = new Prompts(this.ctx);
     this.jobs = new Jobs(this.ctx);
   }
   getRubrics(arg, options) {