@vibexp/api-client 0.92.0 → 0.93.0

package/dist/axios/sdk.gen.js

@@ -3936,6 +3936,210 @@ export const listAdminInstanceEmailSettingsAudit = (options) => (options?.client
     url: '/api/v1/admin/settings/email/audit',
     ...options
 });
+/**
+ * Reset the instance search ranking settings to the built-in defaults
+ *
+ * Removes the stored instance search ranking defaults, so the built-in defaults
+ * apply from the next request, and appends one entry (`action: delete`) to
+ * the `search` audit log. Idempotent: with nothing stored it is still a
+ * 204 and writes no audit entry.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const resetAdminSearchSettings = (options) => (options?.client ?? client).delete({
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/search',
+    ...options
+});
+/**
+ * Get the instance search ranking settings
+ *
+ * Returns the instance search ranking defaults in effect, where they come from
+ * (`instance` or `default`), the built-in defaults, the hard bounds for
+ * form validation, how many teams store settings of their own and the
+ * stored row's `version`. Always 200: with nothing stored, `source` is
+ * `default` and `values` equal `built_in_defaults`.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const getAdminSearchSettings = (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/search',
+    ...options
+});
+/**
+ * Replace the instance search ranking settings
+ *
+ * Validates and stores a whole replacement of the instance search ranking
+ * defaults, taking effect on the next request with no restart, and appends
+ * one entry (`action: upsert`) to the `search` audit log in the same
+ * transaction. Pass `expected_version` to reject the save with 409 when
+ * someone else changed the settings since they were read. A body that
+ * omits a value field, sends one as null, or carries an unknown field is
+ * rejected with 400.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const updateAdminSearchSettings = (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/search',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * List the instance search ranking settings audit log
+ *
+ * Returns one page of the instance search ranking settings' audit log (setting
+ * `search`), newest first, with each actor's display name resolved.
+ * Pass the previous page's `next_cursor` to continue.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const listAdminSearchSettingsAudit = (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/search/audit',
+    ...options
+});
+/**
+ * Reset the instance AI summary settings to the built-in defaults
+ *
+ * Removes the stored instance AI summary defaults and budgets, so the built-in defaults
+ * apply from the next request, and appends one entry (`action: delete`) to
+ * the `ai_summary` audit log. Idempotent: with nothing stored it is still a
+ * 204 and writes no audit entry.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const resetAdminAiSummarySettings = (options) => (options?.client ?? client).delete({
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/admin/settings/ai-summary',
+    ...options
+});
+/**
+ * Get the instance AI summary settings
+ *
+ * Returns the instance AI summary defaults and budgets in effect, where they come from
+ * (`instance` or `default`), the built-in defaults, the hard bounds for
+ * form validation, how many teams store settings of their own and the
+ * stored row's `version`. Always 200: with nothing stored, `source` is
+ * `default` and `values` equal `built_in_defaults`.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const getAdminAiSummarySettings = (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/ai-summary',
+    ...options
+});
+/**
+ * Replace the instance AI summary settings
+ *
+ * Validates and stores a whole replacement of the instance AI summary
+ * defaults and budgets, taking effect on the next request with no restart, and appends
+ * one entry (`action: upsert`) to the `ai_summary` audit log in the same
+ * transaction. Pass `expected_version` to reject the save with 409 when
+ * someone else changed the settings since they were read. A body that
+ * omits a value field, sends one as null, or carries an unknown field is
+ * rejected with 400.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const updateAdminAiSummarySettings = (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/ai-summary',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * List the instance AI summary settings audit log
+ *
+ * Returns one page of the instance AI summary settings' audit log (setting
+ * `ai_summary`), newest first, with each actor's display name resolved.
+ * Pass the previous page's `next_cursor` to continue.
+ * Instance-admin only; non-admin and unauthenticated requests receive 404.
+ *
+ */
+export const listAdminAiSummarySettingsAudit = (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/ai-summary/audit',
+    ...options
+});
 /**
  * List a resource's comments
  *

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

@@ -6236,9 +6236,12 @@ export type AdminInstanceEmailSettings = {
 };
 /**
  * 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`.
+ * snapshots of the setting's values, filtered to that setting's allowlisted
+ * keys, and never contain a credential. For `email_provider` they report
+ * only `has_credential` and, on an upsert's `after`, a `secret` marker
+ * saying whether the credential was `changed` or `unchanged`; the `search`
+ * and `ai_summary` snapshots are the settings' values, which hold no
+ * credential.
  *
  */
 export type AdminInstanceSettingsAuditEntry = {
@@ -6249,7 +6252,7 @@ export type AdminInstanceSettingsAuditEntry = {
     /**
      * The instance setting the entry describes.
      */
-    setting: string;
+    setting: 'email_provider' | 'search' | 'ai_summary';
     /**
      * `upsert` (created or replaced by an admin), `delete` (removed by an
      * admin) or `import` (the boot-time import from config.yaml, which has no
@@ -6294,6 +6297,222 @@ export type AdminInstanceSettingsAuditPage = {
      */
     next_cursor: string | null;
 };
+/**
+ * Where the instance values come from: `instance` when an instance admin (or
+ * the boot-time config import) stored them, `default` when nothing is stored
+ * and the built-in defaults apply.
+ *
+ */
+export type AdminInstanceSettingsSource = 'instance' | 'default';
+/**
+ * The instance search ranking defaults. Every team without its own search
+ * settings ranks with these; `rank_candidate_cap` is instance-only and applies
+ * to every team.
+ *
+ */
+export type AdminInstanceSearchValues = {
+    /**
+     * Whether search results are re-ranked by recency.
+     */
+    recency_ranking_enabled: boolean;
+    /**
+     * Weight of semantic relevance. The three weights must not all be zero.
+     */
+    rank_weight_relevance: number;
+    /**
+     * Weight of creation recency.
+     */
+    rank_weight_created: number;
+    /**
+     * Weight of update recency.
+     */
+    rank_weight_updated: number;
+    /**
+     * Recency half-life in days.
+     */
+    rank_half_life_days: number;
+    /**
+     * How many rows are pulled and re-ranked per search.
+     */
+    rank_candidate_cap: number;
+};
+/**
+ * The hard bounds the search values are validated against, for form validation.
+ */
+export type AdminInstanceSearchLimits = {
+    /**
+     * The smallest allowed weight. The three weights must also not all be zero.
+     */
+    rank_weight_min: number;
+    /**
+     * The largest allowed half-life, in days. The half-life must also be positive.
+     */
+    rank_half_life_days_max: number;
+    rank_candidate_cap_min: number;
+    rank_candidate_cap_max: number;
+};
+/**
+ * The instance search ranking defaults in effect, where they come from and
+ * how many teams ignore them because they store search settings of their own.
+ *
+ */
+export type AdminInstanceSearchSettings = {
+    values: AdminInstanceSearchValues;
+    source: AdminInstanceSettingsSource;
+    built_in_defaults: AdminInstanceSearchValues;
+    limits: AdminInstanceSearchLimits;
+    /**
+     * How many teams store search settings of their own, so a change here does not reach them.
+     */
+    teams_with_override: number;
+    /**
+     * When the values were last stored; null when `source` is `default`.
+     */
+    updated_at: string | null;
+    /**
+     * The admin who last stored the values. Null when `source` is `default`,
+     * for the boot-time import, or once that user has been deleted.
+     *
+     */
+    updated_by_user_id: string | null;
+    /**
+     * That admin's display name (or email), when it could be resolved.
+     */
+    updated_by_name: string | null;
+    /**
+     * The stored row's optimistic-lock version; null when nothing is stored.
+     * Send it back as `expected_version` to reject a save that would
+     * overwrite someone else's change.
+     *
+     */
+    version: number | null;
+};
+/**
+ * A whole replacement of the instance search ranking defaults. Every value is
+ * required. `expected_version` is optional: when present, the save is
+ * rejected with 409 unless it equals the stored version (and when nothing is
+ * stored, any `expected_version` other than null is a conflict). Omit it for
+ * last-write-wins.
+ *
+ */
+export type AdminInstanceSearchSettingsUpdate = {
+    recency_ranking_enabled: boolean;
+    rank_weight_relevance: number;
+    rank_weight_created: number;
+    rank_weight_updated: number;
+    rank_half_life_days: number;
+    rank_candidate_cap: number;
+    /**
+     * The `version` the caller last read; omit or null for last-write-wins.
+     */
+    expected_version?: number | null;
+};
+/**
+ * How detailed a summary is.
+ */
+export type AdminInstanceAiSummaryStyle = 'concise' | 'balanced' | 'detailed';
+/**
+ * The instance AI summary defaults and budgets. `enabled`, `top_n`, `style`
+ * and `max_output_tokens` are the defaults every team without its own AI
+ * summary settings uses; the character budgets and the request timeout are
+ * instance-only and apply to every team.
+ *
+ */
+export type AdminInstanceAiSummaryValues = {
+    enabled: boolean;
+    /**
+     * How many search results a summary reads.
+     */
+    top_n: number;
+    style: AdminInstanceAiSummaryStyle;
+    max_output_tokens: number;
+    /**
+     * How many characters of each document a summary reads.
+     */
+    per_document_chars: number;
+    /**
+     * The total character budget of one summary's context; at least `per_document_chars`.
+     */
+    total_context_chars: number;
+    /**
+     * The summary request timeout, in milliseconds.
+     */
+    request_timeout_ms: number;
+};
+/**
+ * The hard bounds the AI summary values are validated against, for form validation.
+ */
+export type AdminInstanceAiSummaryLimits = {
+    top_n_min: number;
+    top_n_max: number;
+    max_output_tokens_min: number;
+    max_output_tokens_max: number;
+    /**
+     * The smallest allowed character budget. `total_context_chars` must also be at least `per_document_chars`.
+     */
+    chars_min: number;
+    chars_max: number;
+    request_timeout_ms_min: number;
+    request_timeout_ms_max: number;
+};
+/**
+ * The instance AI summary defaults in effect, where they come from and how
+ * many teams ignore the defaults because they store AI summary settings of
+ * their own. The instance-only budgets reach every team regardless.
+ *
+ */
+export type AdminInstanceAiSummarySettings = {
+    values: AdminInstanceAiSummaryValues;
+    source: AdminInstanceSettingsSource;
+    built_in_defaults: AdminInstanceAiSummaryValues;
+    limits: AdminInstanceAiSummaryLimits;
+    /**
+     * How many teams store AI summary settings of their own, so a change to the team defaults does not reach them.
+     */
+    teams_with_override: number;
+    /**
+     * When the values were last stored; null when `source` is `default`.
+     */
+    updated_at: string | null;
+    /**
+     * The admin who last stored the values. Null when `source` is `default`,
+     * for the boot-time import, or once that user has been deleted.
+     *
+     */
+    updated_by_user_id: string | null;
+    /**
+     * That admin's display name (or email), when it could be resolved.
+     */
+    updated_by_name: string | null;
+    /**
+     * The stored row's optimistic-lock version; null when nothing is stored.
+     * Send it back as `expected_version` to reject a save that would
+     * overwrite someone else's change.
+     *
+     */
+    version: number | null;
+};
+/**
+ * A whole replacement of the instance AI summary settings. Every value is
+ * required. `expected_version` is optional: when present, the save is
+ * rejected with 409 unless it equals the stored version (and when nothing is
+ * stored, any `expected_version` other than null is a conflict). Omit it for
+ * last-write-wins.
+ *
+ */
+export type AdminInstanceAiSummarySettingsUpdate = {
+    enabled: boolean;
+    top_n: number;
+    style: AdminInstanceAiSummaryStyle;
+    max_output_tokens: number;
+    per_document_chars: number;
+    total_context_chars: number;
+    request_timeout_ms: number;
+    /**
+     * The `version` the caller last read; omit or null for last-write-wins.
+     */
+    expected_version?: number | null;
+};
 export type ProjectResponse = Project & {
     /**
      * Whether the project's git URL matches a repository accessible via the team's GitHub App installation
@@ -14991,6 +15210,248 @@ export type ListAdminInstanceEmailSettingsAuditResponses = {
     200: AdminInstanceSettingsAuditPage;
 };
 export type ListAdminInstanceEmailSettingsAuditResponse = ListAdminInstanceEmailSettingsAuditResponses[keyof ListAdminInstanceEmailSettingsAuditResponses];
+export type ResetAdminSearchSettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/search';
+};
+export type ResetAdminSearchSettingsErrors = {
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type ResetAdminSearchSettingsError = ResetAdminSearchSettingsErrors[keyof ResetAdminSearchSettingsErrors];
+export type ResetAdminSearchSettingsResponses = {
+    /**
+     * The built-in defaults now apply
+     */
+    204: void;
+};
+export type ResetAdminSearchSettingsResponse = ResetAdminSearchSettingsResponses[keyof ResetAdminSearchSettingsResponses];
+export type GetAdminSearchSettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/search';
+};
+export type GetAdminSearchSettingsErrors = {
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type GetAdminSearchSettingsError = GetAdminSearchSettingsErrors[keyof GetAdminSearchSettingsErrors];
+export type GetAdminSearchSettingsResponses = {
+    /**
+     * The instance search ranking settings
+     */
+    200: AdminInstanceSearchSettings;
+};
+export type GetAdminSearchSettingsResponse = GetAdminSearchSettingsResponses[keyof GetAdminSearchSettingsResponses];
+export type UpdateAdminSearchSettingsData = {
+    body: AdminInstanceSearchSettingsUpdate;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/search';
+};
+export type UpdateAdminSearchSettingsErrors = {
+    /**
+     * Bad request — a value is out of bounds (`INSTANCE_SETTINGS_VALIDATION_FAILED`,
+     * with `validation_errors` naming each offending field), or the body is
+     * malformed, omits or nulls a value field (every value is required), or
+     * carries an unknown field
+     *
+     */
+    400: ErrorResponse;
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict — `expected_version` does not match the stored version (`INSTANCE_SETTINGS_VERSION_CONFLICT`); nothing was changed
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type UpdateAdminSearchSettingsError = UpdateAdminSearchSettingsErrors[keyof UpdateAdminSearchSettingsErrors];
+export type UpdateAdminSearchSettingsResponses = {
+    /**
+     * The stored settings (`source` is `instance`)
+     */
+    200: AdminInstanceSearchSettings;
+};
+export type UpdateAdminSearchSettingsResponse = UpdateAdminSearchSettingsResponses[keyof UpdateAdminSearchSettingsResponses];
+export type ListAdminSearchSettingsAuditData = {
+    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/search/audit';
+};
+export type ListAdminSearchSettingsAuditErrors = {
+    /**
+     * 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 ListAdminSearchSettingsAuditError = ListAdminSearchSettingsAuditErrors[keyof ListAdminSearchSettingsAuditErrors];
+export type ListAdminSearchSettingsAuditResponses = {
+    /**
+     * One page of audit entries, newest first
+     */
+    200: AdminInstanceSettingsAuditPage;
+};
+export type ListAdminSearchSettingsAuditResponse = ListAdminSearchSettingsAuditResponses[keyof ListAdminSearchSettingsAuditResponses];
+export type ResetAdminAiSummarySettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/ai-summary';
+};
+export type ResetAdminAiSummarySettingsErrors = {
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type ResetAdminAiSummarySettingsError = ResetAdminAiSummarySettingsErrors[keyof ResetAdminAiSummarySettingsErrors];
+export type ResetAdminAiSummarySettingsResponses = {
+    /**
+     * The built-in defaults now apply
+     */
+    204: void;
+};
+export type ResetAdminAiSummarySettingsResponse = ResetAdminAiSummarySettingsResponses[keyof ResetAdminAiSummarySettingsResponses];
+export type GetAdminAiSummarySettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/ai-summary';
+};
+export type GetAdminAiSummarySettingsErrors = {
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type GetAdminAiSummarySettingsError = GetAdminAiSummarySettingsErrors[keyof GetAdminAiSummarySettingsErrors];
+export type GetAdminAiSummarySettingsResponses = {
+    /**
+     * The instance AI summary settings
+     */
+    200: AdminInstanceAiSummarySettings;
+};
+export type GetAdminAiSummarySettingsResponse = GetAdminAiSummarySettingsResponses[keyof GetAdminAiSummarySettingsResponses];
+export type UpdateAdminAiSummarySettingsData = {
+    body: AdminInstanceAiSummarySettingsUpdate;
+    path?: never;
+    query?: never;
+    url: '/api/v1/admin/settings/ai-summary';
+};
+export type UpdateAdminAiSummarySettingsErrors = {
+    /**
+     * Bad request — a value is out of bounds (`INSTANCE_SETTINGS_VALIDATION_FAILED`,
+     * with `validation_errors` naming each offending field), or the body is
+     * malformed, omits or nulls a value field (every value is required), or
+     * carries an unknown field
+     *
+     */
+    400: ErrorResponse;
+    /**
+     * Not found — the caller is not an instance admin
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict — `expected_version` does not match the stored version (`INSTANCE_SETTINGS_VERSION_CONFLICT`); nothing was changed
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type UpdateAdminAiSummarySettingsError = UpdateAdminAiSummarySettingsErrors[keyof UpdateAdminAiSummarySettingsErrors];
+export type UpdateAdminAiSummarySettingsResponses = {
+    /**
+     * The stored settings (`source` is `instance`)
+     */
+    200: AdminInstanceAiSummarySettings;
+};
+export type UpdateAdminAiSummarySettingsResponse = UpdateAdminAiSummarySettingsResponses[keyof UpdateAdminAiSummarySettingsResponses];
+export type ListAdminAiSummarySettingsAuditData = {
+    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/ai-summary/audit';
+};
+export type ListAdminAiSummarySettingsAuditErrors = {
+    /**
+     * 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 ListAdminAiSummarySettingsAuditError = ListAdminAiSummarySettingsAuditErrors[keyof ListAdminAiSummarySettingsAuditErrors];
+export type ListAdminAiSummarySettingsAuditResponses = {
+    /**
+     * One page of audit entries, newest first
+     */
+    200: AdminInstanceSettingsAuditPage;
+};
+export type ListAdminAiSummarySettingsAuditResponse = ListAdminAiSummarySettingsAuditResponses[keyof ListAdminAiSummarySettingsAuditResponses];
 export type ListCommentsData = {
     body?: never;
     path: {