@vibexp/api-client 0.89.0 → 0.91.0

package/dist/schema.d.ts

@@ -1037,7 +1037,17 @@ export interface paths {
         put?: never;
         /**
          * Render a prompt
-         * @description Renders a prompt by resolving @references and substituting placeholders with provided values.
+         * @description Renders a prompt by resolving references and substituting placeholders with provided values.
+         *
+         *     A reference is written `@prompt:<slug>` and resolves to a prompt in the
+         *     prompt's own team; `@@` escapes a literal `@`. A bare `@slug` is the
+         *     deprecated legacy form: it expands only when it resolves to a prompt and is
+         *     otherwise left as plain text without a warning, so emails, handles and
+         *     `git@host` remotes are safe. References are resolved on the authored body
+         *     only; placeholder values are inserted verbatim.
+         *
+         *     With `strict: true`, bare `@slug` is never resolved and an unresolved
+         *     `@prompt:<slug>` fails the render with 422.
          */
         post: operations["renderPrompt"];
         delete?: never;
@@ -3515,6 +3525,97 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/settings/email": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the instance email provider settings
+         * @description Returns the instance's stored email provider configuration, its delivery
+         *     health and whether a credential is stored. Always 200: an instance with
+         *     nothing stored reports `configured: false`. The credential is never
+         *     returned.
+         *     Instance-admin only; non-admin and unauthenticated requests receive 404.
+         */
+        get: operations["getAdminInstanceEmailSettings"];
+        /**
+         * Create or replace the instance email provider settings
+         * @description Validates, encrypts and stores the instance's email provider, taking
+         *     effect on the next send with no restart, and appends one redacted entry
+         *     to the audit log. Idempotent: the same body creates or replaces. Omitting
+         *     `secret` keeps the stored credential when the provider type is
+         *     unchanged; an empty `secret` is rejected. A body carrying an unknown
+         *     field is rejected with 400.
+         *     Instance-admin only; non-admin and unauthenticated requests receive 404.
+         */
+        put: operations["upsertAdminInstanceEmailSettings"];
+        post?: never;
+        /**
+         * Remove the instance email provider settings
+         * @description Removes the stored instance email provider and appends one redacted
+         *     entry to the audit log. Instance mail is then discarded until a provider
+         *     is configured again. Returns 409 when nothing is stored.
+         *     Instance-admin only; non-admin and unauthenticated requests receive 404.
+         */
+        delete: operations["deleteAdminInstanceEmailSettings"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/settings/email/test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Send a test message through the instance email provider
+         * @description Sends a fixed test message to the calling admin's own account email,
+         *     through the stored configuration (empty body) or through a candidate
+         *     configuration (see `AdminInstanceEmailTestRequest`). Nothing is stored
+         *     and nothing is audited. A failed send is still a 200, reported with
+         *     `is_valid: false`. A body carrying an unknown field (including a
+         *     `recipient`) is rejected with 400.
+         *     Instance-admin only; non-admin and unauthenticated requests receive 404.
+         */
+        post: operations["testAdminInstanceEmailSettings"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/settings/email/audit": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the instance email provider settings audit log
+         * @description Returns one page of the instance email provider's audit log, newest
+         *     first. Every entry's `before`/`after` snapshot is redacted: it never
+         *     contains a credential. Pass the previous page's `next_cursor` to
+         *     continue.
+         *     Instance-admin only; non-admin and unauthenticated requests receive 404.
+         */
+        get: operations["listAdminInstanceEmailSettingsAudit"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/{team_id}/comments": {
         parameters: {
             query?: never;
@@ -5850,6 +5951,11 @@ export interface components {
             placeholders: {
                 [key: string]: string;
             };
+            /**
+             * @description When true, only explicit @prompt:slug references are resolved (a bare @word such as an email, handle or git@host remote stays literal text), and an unresolved @prompt:slug fails the render with 422 instead of a warning. Recommended for unattended agents.
+             * @default false
+             */
+            strict: boolean;
         };
         RenderPromptResponse: {
             /** @example Please review this code for: security vulnerabilities and code quality */
@@ -5863,9 +5969,9 @@ export interface components {
             placeholders_missing?: string[];
             references_used?: string[];
             /**
-             * @description Warnings about issues during rendering (e.g., missing references)
+             * @description Warnings about issues during rendering, such as an explicit @prompt:slug reference that does not resolve (kept as-is in rendered_body). A bare @word that does not resolve is plain text and never produces a warning.
              * @example [
-             *       "Reference not found: @nonexistent"
+             *       "Reference not found: @prompt:nonexistent"
              *     ]
              */
             warnings?: string[];
@@ -12471,6 +12577,256 @@ export interface components {
              */
             version: number;
         };
+        /**
+         * @description Which provider the instance sends through. Matched case-insensitively.
+         * @example smtp
+         * @enum {string}
+         */
+        AdminInstanceEmailProviderType: "smtp" | "mailgun" | "postmark" | "sendgrid";
+        /**
+         * @description The instance's email provider configuration. This is an upsert, so the same
+         *     body creates or replaces. The per-type `settings` and the write-only
+         *     `secret` follow the team email provider request exactly. A body carrying an
+         *     unknown field is rejected with 400.
+         */
+        AdminInstanceEmailSettingsRequest: {
+            provider_type: components["schemas"]["AdminInstanceEmailProviderType"];
+            settings?: components["schemas"]["TeamEmailProviderSettings"];
+            /**
+             * @description The provider's single credential (SMTP password, Mailgun sending key,
+             *     Postmark server token, or SendGrid API key). It is write-only: never
+             *     returned by any endpoint.
+             *
+             *     OMIT it to keep the stored credential, which is allowed only when the
+             *     provider type is unchanged; a new configuration or a change of provider
+             *     type must carry its own. An explicitly empty string is rejected.
+             * @example key-abc123
+             */
+            secret?: string;
+            /**
+             * Format: email
+             * @description The address instance mail is sent from.
+             * @example noreply@vibexp.example.com
+             */
+            from_address: string;
+            /**
+             * @description Optional display name shown beside the from address.
+             * @example VibeXP
+             */
+            from_name?: string | null;
+            /**
+             * Format: email
+             * @description Optional Reply-To address.
+             * @example support@vibexp.example.com
+             */
+            reply_to?: string | null;
+            /**
+             * Format: email
+             * @description Where the contact form delivers. Omitted or null falls back to the from
+             *     address.
+             * @example hello@vibexp.example.com
+             */
+            contact_recipient_address?: string | null;
+            /**
+             * @description Absolute http(s) URL of the privacy policy linked from outbound mail.
+             *     Omitted or null links none.
+             * @example https://vibexp.example.com/privacy
+             */
+            privacy_policy_url?: string | null;
+        };
+        /**
+         * @description An optional candidate configuration for a test send. An empty body (or an
+         *     empty object) tests the STORED configuration. A body with any field set is
+         *     tested as a full configuration, validated like an upsert; if it omits
+         *     `secret`, the stored credential is used only when the candidate targets
+         *     the same destination (same provider type and, for SMTP, the same
+         *     host/port/username; for Mailgun, the same domain/base URL).
+         *
+         *     There is no recipient field: the test message always goes to the calling
+         *     admin's own account email. A body carrying an unknown field is rejected
+         *     with 400.
+         */
+        AdminInstanceEmailTestRequest: {
+            provider_type?: components["schemas"]["AdminInstanceEmailProviderType"];
+            settings?: components["schemas"]["TeamEmailProviderSettings"];
+            /**
+             * @description The candidate credential. Omit it to test with the stored credential
+             *     (same destination only, see above). Never returned.
+             * @example key-abc123
+             */
+            secret?: string;
+            /**
+             * Format: email
+             * @description The from address to test with.
+             * @example noreply@vibexp.example.com
+             */
+            from_address?: string;
+            /**
+             * @description Optional display name to test with.
+             * @example VibeXP
+             */
+            from_name?: string | null;
+            /**
+             * Format: email
+             * @description Optional Reply-To address to test with.
+             * @example support@vibexp.example.com
+             */
+            reply_to?: string | null;
+            /**
+             * Format: email
+             * @description Accepted for parity with the upsert body; a test send does not use it.
+             * @example hello@vibexp.example.com
+             */
+            contact_recipient_address?: string | null;
+            /**
+             * @description Accepted for parity with the upsert body; a test send does not use it.
+             * @example https://vibexp.example.com/privacy
+             */
+            privacy_policy_url?: string | null;
+        };
+        /**
+         * @description The instance's stored email configuration. This is never a 404: an
+         *     instance with nothing stored reports `configured: false`, with every other
+         *     field null or absent, and discards its mail.
+         *
+         *     No field here can carry the credential; `has_credential` reports only that
+         *     one is stored.
+         */
+        AdminInstanceEmailSettings: {
+            /**
+             * @description Whether an instance email provider is stored.
+             * @example true
+             */
+            configured: boolean;
+            /**
+             * @description The stored provider type, or null when nothing is configured.
+             * @example smtp
+             * @enum {string|null}
+             */
+            provider_type: "smtp" | "mailgun" | "postmark" | "sendgrid" | null;
+            settings?: components["schemas"]["TeamEmailProviderSettings"];
+            /**
+             * @description Whether a credential is stored. The credential itself is never
+             *     returned. An SMTP relay without authentication legitimately has none.
+             * @example true
+             */
+            has_credential: boolean;
+            /**
+             * @description The configured from address; null when nothing is configured.
+             * @example noreply@vibexp.example.com
+             */
+            from_address?: string | null;
+            /**
+             * @description The configured display name.
+             * @example VibeXP
+             */
+            from_name?: string | null;
+            /**
+             * @description The configured Reply-To address.
+             * @example support@vibexp.example.com
+             */
+            reply_to?: string | null;
+            /**
+             * @description Where the contact form delivers; null falls back to the from address.
+             * @example hello@vibexp.example.com
+             */
+            contact_recipient_address?: string | null;
+            /**
+             * @description The privacy policy URL linked from outbound mail; null links none.
+             * @example https://vibexp.example.com/privacy
+             */
+            privacy_policy_url?: string | null;
+            /**
+             * @description Whether the last observed send succeeded, derived by comparing
+             *     `last_success_at` with `last_error_at` (a provider that has never sent
+             *     is healthy). Null when nothing is configured.
+             * @example true
+             */
+            is_healthy: boolean | null;
+            /**
+             * Format: date-time
+             * @description When a send through the instance provider last succeeded.
+             */
+            last_success_at?: string | null;
+            /**
+             * @description The last delivery error, retained after recovery for diagnosis; use
+             *     `is_healthy` to tell whether the provider is currently failing.
+             * @example smtp: connection refused
+             */
+            last_error?: string | null;
+            /**
+             * Format: date-time
+             * @description When the last delivery error occurred.
+             */
+            last_error_at?: string | null;
+            /**
+             * Format: date-time
+             * @description When the configuration was last saved; null when nothing is configured.
+             */
+            updated_at?: string | null;
+            /**
+             * Format: uuid
+             * @description The admin who last saved the configuration. Null for the boot-time
+             *     import from config.yaml, or once that user has been deleted.
+             */
+            updated_by?: string | null;
+        };
+        /**
+         * @description One append-only change to an instance setting. `before` and `after` are
+         *     REDACTED snapshots: they never contain a credential, only
+         *     `has_credential` and, on an upsert's `after`, a `secret` marker saying
+         *     whether the credential was `changed` or `unchanged`.
+         */
+        AdminInstanceSettingsAuditEntry: {
+            /**
+             * Format: uuid
+             * @description Audit entry id.
+             */
+            id: string;
+            /**
+             * @description The instance setting the entry describes.
+             * @example email_provider
+             */
+            setting: string;
+            /**
+             * @description `upsert` (created or replaced by an admin), `delete` (removed by an
+             *     admin) or `import` (the boot-time import from config.yaml, which has no
+             *     actor).
+             * @example upsert
+             * @enum {string}
+             */
+            action: "upsert" | "delete" | "import";
+            /**
+             * Format: uuid
+             * @description The admin who made the change. Null for an import, or once that user
+             *     has been deleted.
+             */
+            actor_user_id: string | null;
+            /**
+             * @description The actor's display name (or email), when it could be resolved.
+             * @example Ada Admin
+             */
+            actor_name: string | null;
+            /** @description The redacted setting before the change; null when the change created it. */
+            before: {
+                [key: string]: unknown;
+            } | null;
+            /** @description The redacted setting after the change; null when the change deleted it. */
+            after: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Format: date-time
+             * @description When the change was made.
+             */
+            created_at: string;
+        };
+        /** @description One page of an instance setting's audit log, newest first. */
+        AdminInstanceSettingsAuditPage: {
+            entries: components["schemas"]["AdminInstanceSettingsAuditEntry"][];
+            /** @description Opaque cursor for the next page; null on the last page. */
+            next_cursor: string | null;
+        };
         ProjectResponse: components["schemas"]["Project"] & {
             /**
              * @description Whether the project's git URL matches a repository accessible via the team's GitHub App installation
@@ -16700,6 +17056,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ErrorResponse"];
                 };
             };
+            /** @description Strict render failed: one or more explicit @prompt:slug references do not resolve. The detail names the missing slugs. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
         };
     };
     getPromptShare: {
@@ -24051,6 +24416,250 @@ export interface operations {
             };
         };
     };
+    getAdminInstanceEmailSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The instance email provider settings */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminInstanceEmailSettings"];
+                };
+            };
+            /** @description Not found — the caller is not an instance admin */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    upsertAdminInstanceEmailSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdminInstanceEmailSettingsRequest"];
+            };
+        };
+        responses: {
+            /** @description The stored settings */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminInstanceEmailSettings"];
+                };
+            };
+            /**
+             * @description Bad request — the configuration is invalid (`INSTANCE_EMAIL_PROVIDER_VALIDATION_FAILED`,
+             *     with `validation_errors`), or the body carries an unknown field
+             */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Not found — the caller is not an instance admin */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    deleteAdminInstanceEmailSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The settings were removed */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not found — the caller is not an instance admin */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Conflict — no instance email provider is configured (`INSTANCE_EMAIL_PROVIDER_NOT_CONFIGURED`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    testAdminInstanceEmailSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["AdminInstanceEmailTestRequest"];
+            };
+        };
+        responses: {
+            /** @description The outcome of the test send */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TeamEmailProviderTestResponse"];
+                };
+            };
+            /**
+             * @description Bad request — the candidate configuration is invalid, nothing is stored to
+             *     test (`INSTANCE_EMAIL_PROVIDER_VALIDATION_FAILED`), or the body carries an
+             *     unknown field
+             */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Not found — the caller is not an instance admin */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    listAdminInstanceEmailSettingsAudit: {
+        parameters: {
+            query?: {
+                /** @description Opaque cursor from a previous page's `next_cursor`. */
+                cursor?: string;
+                /** @description Page size. */
+                limit?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One page of audit entries, newest first */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminInstanceSettingsAuditPage"];
+                };
+            };
+            /** @description Bad request — malformed cursor, or `limit` out of range */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Not found — the caller is not an instance admin */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listComments: {
         parameters: {
             query: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibexp/api-client",
-  "version": "0.89.0",
+  "version": "0.91.0",
   "description": "Typed VibeXP API client generated from the OpenAPI spec (openapi-fetch main entrypoint, axios SDK at ./axios)",
   "license": "MIT",
   "repository": {