@vibexp/api-client 0.89.0 → 0.91.0

package/dist/axios/sdk.gen.js

@@ -1040,7 +1040,17 @@ export const getPromptDependencies = (options) => (options.client ?? client).get
 /**
  * Render a prompt
  *
- * Renders a prompt by resolving @references and substituting placeholders with provided values.
+ * 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.
  *
  */
 export const renderPrompt = (options) => (options.client ?? client).post({
@@ -3796,6 +3806,136 @@ export const exportAdminProjects = (options) => (options?.client ?? client).get(
     url: '/api/v1/admin/projects/export',
     ...options
 });
+/**
+ * Remove the instance email provider settings
+ *
+ * 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.
+ *
+ */
+export const deleteAdminInstanceEmailSettings = (options) => (options?.client ?? client).delete({
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/email',
+    ...options
+});
+/**
+ * Get the instance email provider settings
+ *
+ * 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.
+ *
+ */
+export const getAdminInstanceEmailSettings = (options) => (options?.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/email',
+    ...options
+});
+/**
+ * Create or replace the instance email provider settings
+ *
+ * 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.
+ *
+ */
+export const upsertAdminInstanceEmailSettings = (options) => (options.client ?? client).put({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/email',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Send a test message through the instance email provider
+ *
+ * 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.
+ *
+ */
+export const testAdminInstanceEmailSettings = (options) => (options?.client ?? client).post({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/email/test',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers
+    }
+});
+/**
+ * List the instance email provider settings audit log
+ *
+ * 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.
+ *
+ */
+export const listAdminInstanceEmailSettingsAudit = (options) => (options?.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/email/audit',
+    ...options
+});
 /**
  * List a resource's comments
  *

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

@@ -376,6 +376,10 @@ export type RenderPromptRequest = {
     placeholders: {
         [key: string]: string;
     };
+    /**
+     * 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.
+     */
+    strict?: boolean;
 };
 export type RenderPromptResponse = {
     rendered_body: string;
@@ -385,7 +389,7 @@ export type RenderPromptResponse = {
     placeholders_missing?: Array<string>;
     references_used?: Array<string>;
     /**
-     * Warnings about issues during rendering (e.g., missing references)
+     * 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.
      */
     warnings?: Array<string>;
 };
@@ -6050,6 +6054,236 @@ export type AdminSavedFiltersReplaceRequest = {
      */
     version: number;
 };
+/**
+ * Which provider the instance sends through. Matched case-insensitively.
+ */
+export type AdminInstanceEmailProviderType = 'smtp' | 'mailgun' | 'postmark' | 'sendgrid';
+/**
+ * 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.
+ *
+ */
+export type AdminInstanceEmailSettingsRequest = {
+    provider_type: AdminInstanceEmailProviderType;
+    settings?: TeamEmailProviderSettings;
+    /**
+     * 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.
+     *
+     */
+    secret?: string;
+    /**
+     * The address instance mail is sent from.
+     */
+    from_address: string;
+    /**
+     * Optional display name shown beside the from address.
+     */
+    from_name?: string | null;
+    /**
+     * Optional Reply-To address.
+     */
+    reply_to?: string | null;
+    /**
+     * Where the contact form delivers. Omitted or null falls back to the from
+     * address.
+     *
+     */
+    contact_recipient_address?: string | null;
+    /**
+     * Absolute http(s) URL of the privacy policy linked from outbound mail.
+     * Omitted or null links none.
+     *
+     */
+    privacy_policy_url?: string | null;
+};
+/**
+ * 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.
+ *
+ */
+export type AdminInstanceEmailTestRequest = {
+    provider_type?: AdminInstanceEmailProviderType;
+    settings?: TeamEmailProviderSettings;
+    /**
+     * The candidate credential. Omit it to test with the stored credential
+     * (same destination only, see above). Never returned.
+     *
+     */
+    secret?: string;
+    /**
+     * The from address to test with.
+     */
+    from_address?: string;
+    /**
+     * Optional display name to test with.
+     */
+    from_name?: string | null;
+    /**
+     * Optional Reply-To address to test with.
+     */
+    reply_to?: string | null;
+    /**
+     * Accepted for parity with the upsert body; a test send does not use it.
+     */
+    contact_recipient_address?: string | null;
+    /**
+     * Accepted for parity with the upsert body; a test send does not use it.
+     */
+    privacy_policy_url?: string | null;
+};
+/**
+ * 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.
+ *
+ */
+export type AdminInstanceEmailSettings = {
+    /**
+     * Whether an instance email provider is stored.
+     */
+    configured: boolean;
+    /**
+     * The stored provider type, or null when nothing is configured.
+     */
+    provider_type: 'smtp' | 'mailgun' | 'postmark' | 'sendgrid' | null;
+    settings?: TeamEmailProviderSettings;
+    /**
+     * Whether a credential is stored. The credential itself is never
+     * returned. An SMTP relay without authentication legitimately has none.
+     *
+     */
+    has_credential: boolean;
+    /**
+     * The configured from address; null when nothing is configured.
+     */
+    from_address?: string | null;
+    /**
+     * The configured display name.
+     */
+    from_name?: string | null;
+    /**
+     * The configured Reply-To address.
+     */
+    reply_to?: string | null;
+    /**
+     * Where the contact form delivers; null falls back to the from address.
+     */
+    contact_recipient_address?: string | null;
+    /**
+     * The privacy policy URL linked from outbound mail; null links none.
+     */
+    privacy_policy_url?: string | null;
+    /**
+     * 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.
+     *
+     */
+    is_healthy: boolean | null;
+    /**
+     * When a send through the instance provider last succeeded.
+     */
+    last_success_at?: string | null;
+    /**
+     * The last delivery error, retained after recovery for diagnosis; use
+     * `is_healthy` to tell whether the provider is currently failing.
+     *
+     */
+    last_error?: string | null;
+    /**
+     * When the last delivery error occurred.
+     */
+    last_error_at?: string | null;
+    /**
+     * When the configuration was last saved; null when nothing is configured.
+     */
+    updated_at?: string | null;
+    /**
+     * 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;
+};
+/**
+ * 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`.
+ *
+ */
+export type AdminInstanceSettingsAuditEntry = {
+    /**
+     * Audit entry id.
+     */
+    id: string;
+    /**
+     * The instance setting the entry describes.
+     */
+    setting: string;
+    /**
+     * `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).
+     *
+     */
+    action: 'upsert' | 'delete' | 'import';
+    /**
+     * The admin who made the change. Null for an import, or once that user
+     * has been deleted.
+     *
+     */
+    actor_user_id: string | null;
+    /**
+     * The actor's display name (or email), when it could be resolved.
+     */
+    actor_name: string | null;
+    /**
+     * The redacted setting before the change; null when the change created it.
+     */
+    before: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The redacted setting after the change; null when the change deleted it.
+     */
+    after: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * When the change was made.
+     */
+    created_at: string;
+};
+/**
+ * One page of an instance setting's audit log, newest first.
+ */
+export type AdminInstanceSettingsAuditPage = {
+    entries: Array<AdminInstanceSettingsAuditEntry>;
+    /**
+     * Opaque cursor for the next page; null on the last page.
+     */
+    next_cursor: string | null;
+};
 export type ProjectResponse = Project & {
     /**
      * Whether the project's git URL matches a repository accessible via the team's GitHub App installation
@@ -9127,6 +9361,10 @@ export type RenderPromptErrors = {
      * Prompt not found
      */
     404: ErrorResponse;
+    /**
+     * Strict render failed: one or more explicit @prompt:slug references do not resolve. The detail names the missing slugs.
+     */
+    422: ErrorResponse;
 };
 export type RenderPromptError = RenderPromptErrors[keyof RenderPromptErrors];
 export type RenderPromptResponses = {
@@ -14593,6 +14831,156 @@ export type ExportAdminProjectsResponses = {
     200: string;
 };
 export type ExportAdminProjectsResponse = ExportAdminProjectsResponses[keyof ExportAdminProjectsResponses];
+export type DeleteAdminInstanceEmailSettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/email';
+};
+export type DeleteAdminInstanceEmailSettingsErrors = {
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict — no instance email provider is configured (`INSTANCE_EMAIL_PROVIDER_NOT_CONFIGURED`)
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type DeleteAdminInstanceEmailSettingsError = DeleteAdminInstanceEmailSettingsErrors[keyof DeleteAdminInstanceEmailSettingsErrors];
+export type DeleteAdminInstanceEmailSettingsResponses = {
+    /**
+     * The settings were removed
+     */
+    204: void;
+};
+export type DeleteAdminInstanceEmailSettingsResponse = DeleteAdminInstanceEmailSettingsResponses[keyof DeleteAdminInstanceEmailSettingsResponses];
+export type GetAdminInstanceEmailSettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/email';
+};
+export type GetAdminInstanceEmailSettingsErrors = {
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type GetAdminInstanceEmailSettingsError = GetAdminInstanceEmailSettingsErrors[keyof GetAdminInstanceEmailSettingsErrors];
+export type GetAdminInstanceEmailSettingsResponses = {
+    /**
+     * The instance email provider settings
+     */
+    200: AdminInstanceEmailSettings;
+};
+export type GetAdminInstanceEmailSettingsResponse = GetAdminInstanceEmailSettingsResponses[keyof GetAdminInstanceEmailSettingsResponses];
+export type UpsertAdminInstanceEmailSettingsData = {
+    body: AdminInstanceEmailSettingsRequest;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/email';
+};
+export type UpsertAdminInstanceEmailSettingsErrors = {
+    /**
+     * Bad request — the configuration is invalid (`INSTANCE_EMAIL_PROVIDER_VALIDATION_FAILED`,
+     * with `validation_errors`), or the body carries an unknown field
+     *
+     */
+    400: ErrorResponse;
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type UpsertAdminInstanceEmailSettingsError = UpsertAdminInstanceEmailSettingsErrors[keyof UpsertAdminInstanceEmailSettingsErrors];
+export type UpsertAdminInstanceEmailSettingsResponses = {
+    /**
+     * The stored settings
+     */
+    200: AdminInstanceEmailSettings;
+};
+export type UpsertAdminInstanceEmailSettingsResponse = UpsertAdminInstanceEmailSettingsResponses[keyof UpsertAdminInstanceEmailSettingsResponses];
+export type TestAdminInstanceEmailSettingsData = {
+    body?: AdminInstanceEmailTestRequest;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/email/test';
+};
+export type TestAdminInstanceEmailSettingsErrors = {
+    /**
+     * 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: ErrorResponse;
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type TestAdminInstanceEmailSettingsError = TestAdminInstanceEmailSettingsErrors[keyof TestAdminInstanceEmailSettingsErrors];
+export type TestAdminInstanceEmailSettingsResponses = {
+    /**
+     * The outcome of the test send
+     */
+    200: TeamEmailProviderTestResponse;
+};
+export type TestAdminInstanceEmailSettingsResponse = TestAdminInstanceEmailSettingsResponses[keyof TestAdminInstanceEmailSettingsResponses];
+export type ListAdminInstanceEmailSettingsAuditData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Opaque cursor from a previous page's `next_cursor`.
+         */
+        cursor?: string;
+        /**
+         * Page size.
+         */
+        limit?: number;
+    };
+    url: '/api/v1/admin/settings/email/audit';
+};
+export type ListAdminInstanceEmailSettingsAuditErrors = {
+    /**
+     * Bad request — malformed cursor, or `limit` out of range
+     */
+    400: ErrorResponse;
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type ListAdminInstanceEmailSettingsAuditError = ListAdminInstanceEmailSettingsAuditErrors[keyof ListAdminInstanceEmailSettingsAuditErrors];
+export type ListAdminInstanceEmailSettingsAuditResponses = {
+    /**
+     * One page of audit entries, newest first
+     */
+    200: AdminInstanceSettingsAuditPage;
+};
+export type ListAdminInstanceEmailSettingsAuditResponse = ListAdminInstanceEmailSettingsAuditResponses[keyof ListAdminInstanceEmailSettingsAuditResponses];
 export type ListCommentsData = {
     body?: never;
     path: {