@vibexp/api-client 0.58.0 → 0.60.0

package/dist/axios/sdk.gen.js

@@ -3533,6 +3533,256 @@ export const updateTeamSearchSettings = (options) => (options.client ?? client).
         ...options.headers
     }
 });
+/**
+ * List the team's freshness rules
+ *
+ * Returns every freshness rule the team has defined, oldest first. Any member of the team may read them. The array is empty, never null, when the team has no rules.
+ *
+ */
+export const listFreshnessRules = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/rules',
+    ...options
+});
+/**
+ * Create a freshness rule
+ *
+ * Adds a rule to the team. Requires the `team.settings.update` permission. An omitted `mediums` matches any medium; an omitted or null `project_id` applies the rule to every project in the team.
+ *
+ */
+export const createFreshnessRule = (options) => (options.client ?? client).post({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/rules',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Delete a freshness rule
+ *
+ * Removes the rule and strips it from any freshness state that matched it, so no stale resource keeps referencing a rule that no longer exists. Requires the `team.settings.update` permission.
+ *
+ */
+export const deleteFreshnessRule = (options) => (options.client ?? client).delete({
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/rules/{rule_id}',
+    ...options
+});
+/**
+ * Replace a freshness rule
+ *
+ * Replaces the rule in full — every mutable field is required, because an omitted field would otherwise reset that dimension. Requires the `team.settings.update` permission.
+ *
+ */
+export const updateFreshnessRule = (options) => (options.client ?? client).put({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/rules/{rule_id}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Reset the team's freshness settings to the defaults
+ *
+ * Removes the team's stored settings so it inherits the defaults again. Requires the `team.settings.update` permission. Resetting a team that has no stored settings succeeds and changes nothing.
+ *
+ */
+export const resetTeamFreshnessSettings = (options) => (options.client ?? client).delete({
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/settings/freshness',
+    ...options
+});
+/**
+ * Get the team's freshness settings
+ *
+ * Returns the freshness evaluation settings in effect for the team, their provenance (`source`), and the defaults a reset would restore. A team that has never overridden them gets `source: instance`. Any member may read them.
+ *
+ */
+export const getTeamFreshnessSettings = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/settings/freshness',
+    ...options
+});
+/**
+ * Override the team's freshness settings
+ *
+ * Replaces the team's freshness settings in full. `interval_seconds` below 3600 (one hour) is rejected. Requires the `team.settings.update` permission.
+ *
+ */
+export const updateTeamFreshnessSettings = (options) => (options.client ?? client).put({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/settings/freshness',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Freshness activity over time
+ *
+ * Daily marked/cleared counts and the reconstructed stale level over the requested window, zero-filled so every day in the range is present.
+ *
+ */
+export const getFreshnessOverTimeMetrics = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/metrics/over-time',
+    ...options
+});
+/**
+ * Stale resources by resource type
+ *
+ * Current stale counts per resource type. All four types are always present; one with nothing stale reports 0.
+ *
+ */
+export const getFreshnessByTypeMetrics = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/metrics/by-type',
+    ...options
+});
+/**
+ * Stale resources by project
+ *
+ * Current stale counts per project in the team, including projects with nothing stale.
+ *
+ */
+export const getFreshnessByProjectMetrics = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/metrics/by-project',
+    ...options
+});
+/**
+ * Resources marked by each rule
+ *
+ * How many resources each of the team's rules currently marks, including rules that match nothing. This is how an over-broad rule is spotted.
+ *
+ */
+export const getFreshnessByRuleMetrics = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/metrics/by-rule',
+    ...options
+});
+/**
+ * List the team's freshness audit log
+ *
+ * Every recorded mark and clear for the team, newest first and paginated. Readable by any member. The list is empty, never null, past the last page.
+ *
+ */
+export const listFreshnessAudit = (options) => (options.client ?? client).get({
+    responseType: 'json',
+    security: [{
+            key: 'ApiKeyAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            in: 'cookie',
+            name: 'vx_session',
+            type: 'apiKey'
+        }],
+    url: '/api/v1/{team_id}/freshness/audit',
+    ...options
+});
 /**
  * List embedding providers
  *