@nangohq/types 0.71.1 → 0.71.3

package/dist/billing/types.d.ts

@@ -94,19 +94,12 @@ export interface GetBillingUsageOpts {
         group_by?: 'environmentId' | 'environmentName' | 'integrationId' | 'type' | 'functionName' | 'model';
     };
     /**
-     * Dev-only escape hatch: pins the request to Orb for parity checks.
-     * Honoured only when `FLAG_ALLOW_OVERRIDE_GETUSAGE_SERVICE` is enabled;
-     * ignored everywhere else. Default is ClickHouse.
-     */
-    source?: 'clickhouse' | 'orb';
-    /**
-     * Per-metric dimension breakdown spec. Honoured only on the CH path
+     * Per-metric dimension breakdown spec, applied to CH-backed metrics
      * (records / connections via `getDailySumAndBatches`, counters via
-     * `getDailyCounter`); the Orb client ignores it. Each metric's
-     * `BillingUsageMetric` gains a `breakdown` array of up to `top + 1`
-     * series (top-N dimension values + a single 'rest' aggregating the
-     * long tail). Top defaults to 10 and is clamped server-side to
-     * the CH cap.
+     * `getDailyCounter`). Each metric's `BillingUsageMetric` gains a
+     * `breakdown` array of up to `top + 1` series (top-N dimension
+     * values + a single 'rest' aggregating the long tail). Top defaults
+     * to 10 and is clamped server-side to the CH cap.
      */
     breakdown?: {
         [M in UsageMetric]?: BreakdownDimensions[M] | undefined;
@@ -114,8 +107,7 @@ export interface GetBillingUsageOpts {
     top?: number;
     /**
      * Subset of metrics to populate in the response. When set, only those
-     * metrics are fanned out (CH path) and returned. Omitted → all 7.
-     * Ignored on the Orb path.
+     * metrics are fanned out and returned. Omitted → all 7.
      */
     metrics?: UsageMetric[];
     /**
@@ -123,8 +115,7 @@ export interface GetBillingUsageOpts {
      * where the given dimension equals the given value. Composes with
      * `breakdown[<metric>]` on the same metric when the dimensions differ
      * (drill-in: filter to one value, re-break-down by another); controllers
-     * reject only the same-dimension pairing. CH path only; the Orb client
-     * ignores it.
+     * reject only the same-dimension pairing.
      */
     filter?: {
         [M in UsageMetric]?: {

package/dist/cli/api.d.ts

@@ -1,6 +1,10 @@
-import type { Endpoint } from '../api.js';
+import type { ApiEndpoint } from '../api.js';
 export type CliTelemetryEvent = 'cli:init' | 'cli:create' | 'cli:compile' | 'cli:dev' | 'cli:dryrun' | 'cli:generate:docs' | 'cli:generate:tests' | 'cli:clone' | 'cli:migrate_to_zero_yaml' | 'cli:deploy' | 'cli:pull';
-export type PostCliTelemetry = Endpoint<{
+export type PostCliTelemetry = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/cli/telemetry';
     Body: {

package/dist/clientMetadata/http.api.d.ts

@@ -1,5 +1,9 @@
-import type { ApiError, Endpoint } from '../api.js';
-export type GetPublicClientMetadata = Endpoint<{
+import type { ApiEndpoint, ApiError } from '../api.js';
+export type GetPublicClientMetadata = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/oauth/client-metadata/:environmentUuid/:providerConfigKey';
     Params: {

package/dist/connect/api.d.ts

@@ -1,4 +1,4 @@
-import type { Endpoint } from '../api.js';
+import type { ApiEndpoint } from '../api.js';
 import type { ConnectUISettings } from '../connectUISettings/dto.js';
 import type { ApiEndUser } from '../endUser/index.js';
 export interface ConnectSessionInput {
@@ -33,6 +33,11 @@ export type ConnectSessionOutput = Omit<ConnectSessionInput, 'end_user' | 'organ
     endUser: ApiEndUser | null;
     isReconnecting?: boolean;
     connectUISettings: ConnectUISettings;
+    /**
+     * Server-side WebSocket upgrade path (NANGO_SERVER_WEBSOCKETS_PATH), sent on self-hosted
+     * deployments so Connect UI opens its OAuth-result socket on the matching path.
+     */
+    websocketsPath?: string;
 };
 export type PostConnectSessionsBody = ConnectSessionInput | (Omit<ConnectSessionInput, 'end_user' | 'tags'> & {
     /**
@@ -41,7 +46,11 @@ export type PostConnectSessionsBody = ConnectSessionInput | (Omit<ConnectSession
     tags: NonNullable<ConnectSessionInput['tags']>;
     end_user?: ConnectSessionInput['end_user'] | undefined;
 });
-export type PostConnectSessions = Endpoint<{
+export type PostConnectSessions = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/connect/sessions';
     Body: PostConnectSessionsBody;
@@ -53,7 +62,11 @@ export type PostConnectSessions = Endpoint<{
         };
     };
 }>;
-export type PostPublicConnectSessionsReconnect = Endpoint<{
+export type PostPublicConnectSessionsReconnect = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/connect/sessions/reconnect';
     Body: {
@@ -74,25 +87,41 @@ export type PostPublicConnectSessionsReconnect = Endpoint<{
         };
     };
 }>;
-export type GetConnectSession = Endpoint<{
+export type GetConnectSession = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/connect/session';
     Success: {
         data: ConnectSessionOutput;
     };
 }>;
-export type DeleteConnectSession = Endpoint<{
+export type DeleteConnectSession = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'DELETE';
     Path: '/connect/session';
     Success: never;
 }>;
-export type PostInternalConnectSessions = Endpoint<{
+export type PostInternalConnectSessions = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/api/v1/connect/sessions';
     Success: PostConnectSessions['Success'];
     Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization' | 'integrations_config_defaults' | 'overrides' | 'webhook_url_override'>;
 }>;
-export type PostPublicConnectTelemetry = Endpoint<{
+export type PostPublicConnectTelemetry = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/connect/telemetry';
     Body: {

package/dist/connectUISettings/api.d.ts

@@ -1,6 +1,10 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
 import type { ConnectUISettings } from './dto.js';
-export type GetConnectUISettings = Endpoint<{
+export type GetConnectUISettings = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/connect-ui-settings';
     Querystring: {
@@ -11,7 +15,11 @@ export type GetConnectUISettings = Endpoint<{
     };
     Error: ApiError<'failed_to_get_connect_ui_settings'>;
 }>;
-export type PutConnectUISettings = Endpoint<{
+export type PutConnectUISettings = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'PUT';
     Path: '/api/v1/connect-ui-settings';
     Querystring: {

package/dist/connection/api/get.d.ts

@@ -1,5 +1,6 @@
-import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
-import type { AllAuthCredentials, ApiKeyCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
+import type { ApiEndpoint, ApiError, ApiTimestamps } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
+import type { ApiKeyCredentials, ApiPublicAllAuthCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
 import type { EndUserInput } from '../../connect/api.js';
 import type { Tags } from '../../db.js';
 import type { ApiEndUser } from '../../endUser/index.js';
@@ -17,7 +18,11 @@ export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id'
     tags: Tags;
     pausedSyncs: string[];
 };
-export type GetConnections = Endpoint<{
+export type GetConnections = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Querystring: {
         env: string;
@@ -31,7 +36,11 @@ export type GetConnections = Endpoint<{
         data: ApiConnectionSimple[];
     };
 }>;
-export type GetConnectionsCount = Endpoint<{
+export type GetConnectionsCount = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Querystring: {
         env: string;
@@ -58,7 +67,11 @@ export type ApiPublicConnection = Pick<DBConnection, 'id' | 'connection_id'> & {
     end_user: ApiEndUser | null;
     tags: Tags;
 };
-export type GetPublicConnections = Endpoint<{
+export type GetPublicConnections = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Querystring: {
         connectionId?: string | undefined;
@@ -75,7 +88,8 @@ export type GetPublicConnections = Endpoint<{
         connections: ApiPublicConnection[];
     };
 }>;
-export type PostPublicConnection = Endpoint<{
+export type PostPublicConnection = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'created', 'environment'>;
     Method: 'POST';
     Path: '/connections';
     Body: {
@@ -102,7 +116,7 @@ export type PostPublicConnection = Endpoint<{
     Success: ApiPublicConnectionFull;
 }>;
 export type ApiConnectionFull = Omit<ReplaceInObject<DBConnectionDecrypted, Date, string>, 'credentials_iv' | 'end_user_id' | 'credentials_tag' | 'deleted' | 'deleted_at'>;
-export type GetConnection = Endpoint<{
+export type GetConnection = ApiEndpoint<{
     Method: 'GET';
     Params: {
         connectionId: string;
@@ -113,6 +127,10 @@ export type GetConnection = Endpoint<{
     };
     Path: '/api/v1/connections/:connectionId';
     Error: ApiError<'unknown_provider_config'>;
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Success: {
         data: {
             provider: string;
@@ -135,9 +153,13 @@ export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id'
     }[];
     end_user: ApiEndUser | null;
     tags: Tags;
-    credentials: AllAuthCredentials;
+    credentials: ApiPublicAllAuthCredentials;
 };
-export type GetPublicConnection = Endpoint<{
+export type GetPublicConnection = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Params: {
         connectionId: string;
@@ -152,7 +174,8 @@ export type GetPublicConnection = Endpoint<{
     Error: ApiError<'unknown_provider_config' | 'invalid_credentials'>;
     Success: ApiPublicConnectionFull;
 }>;
-export type PatchPublicConnection = Endpoint<{
+export type PatchPublicConnection = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'updated', 'environment'>;
     Method: 'PATCH';
     Path: '/connections/:connectionId';
     Params: {
@@ -164,14 +187,15 @@ export type PatchPublicConnection = Endpoint<{
     Body: {
         end_user?: EndUserInput | undefined;
         tags?: Tags | undefined;
-        webhook_url?: string | undefined;
+        webhook_url_override?: string | undefined;
     };
     Success: {
         success: boolean;
     };
     Error: ApiError<'unknown_provider_config' | 'not_found' | 'server_error' | 'invalid_body'>;
 }>;
-export type PatchConnection = Endpoint<{
+export type PatchConnection = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'updated', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/connections/:connectionId';
     Params: {
@@ -184,14 +208,15 @@ export type PatchConnection = Endpoint<{
     Body: {
         end_user?: EndUserInput | undefined;
         tags?: Tags | undefined;
-        webhook_url?: string | undefined;
+        webhook_url_override?: string | undefined;
     };
     Success: {
         success: boolean;
     };
     Error: ApiError<'unknown_provider_config' | 'not_found' | 'server_error' | 'invalid_body'>;
 }>;
-export type PostConnectionRefresh = Endpoint<{
+export type PostConnectionRefresh = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'refreshed', 'environment'>;
     Method: 'POST';
     Params: {
         connectionId: string;
@@ -208,7 +233,8 @@ export type PostConnectionRefresh = Endpoint<{
         };
     };
 }>;
-export type DeletePublicConnection = Endpoint<{
+export type DeletePublicConnection = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'deleted', 'environment'>;
     Method: 'DELETE';
     Path: '/connection/:connectionId';
     Params: {
@@ -222,7 +248,7 @@ export type DeletePublicConnection = Endpoint<{
         success: boolean;
     };
 }>;
-export type DeleteConnection = Endpoint<{
+export type DeleteConnection = ApiEndpoint<{
     Method: 'DELETE';
     Path: '/api/v1/connections/:connectionId';
     Params: {
@@ -236,4 +262,5 @@ export type DeleteConnection = Endpoint<{
     Success: {
         success: boolean;
     };
+    Audit: AuditPolicy<'connection', 'deleted', 'environment'>;
 }>;

package/dist/connection/api/metadata.d.ts

@@ -1,4 +1,5 @@
-import type { ApiError, Endpoint } from '../../api.js';
+import type { ApiEndpoint, ApiError } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
 import type { Metadata } from '../db.js';
 export interface MetadataBody {
     connection_id: string | string[];
@@ -6,21 +7,24 @@ export interface MetadataBody {
     metadata: Metadata;
 }
 type MetadataError = ApiError<'invalid_body'> | ApiError<'unknown_connection'>;
-export type SetMetadata = Endpoint<{
+export type SetMetadata = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'metadata_updated', 'environment'>;
     Method: 'POST';
     Body: MetadataBody;
     Path: '/connection/metadata';
     Error: MetadataError;
     Success: MetadataBody;
 }>;
-export type UpdateMetadata = Endpoint<{
+export type UpdateMetadata = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'metadata_updated', 'environment'>;
     Method: 'PATCH';
     Path: '/connection/metadata';
     Body: MetadataBody;
     Error: MetadataError;
     Success: MetadataBody;
 }>;
-export type PostConnectionMetadata = Endpoint<{
+export type PostConnectionMetadata = ApiEndpoint<{
+    Audit: AuditPolicy<'connection', 'metadata_updated', 'environment'>;
     Method: 'POST';
     Path: '/api/v1/connections/:connectionId/metadata';
     Params: {

package/dist/db.d.ts

@@ -10,8 +10,13 @@ export interface DeletedCorrect {
     deleted_at: Date | null;
     deleted: boolean;
 }
+export interface DeletedAt {
+    deleted_at: Date | null;
+}
 export interface TimestampsAndDeleted extends Timestamps, Deleted {
 }
 export interface TimestampsAndDeletedCorrect extends Timestamps, DeletedCorrect {
 }
+export interface TimestampsAndDeletedAt extends Timestamps, DeletedAt {
+}
 export type Tags = Record<string, string>;

package/dist/deploy/api.d.ts

@@ -1,10 +1,15 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
 import type { OnEventType } from '../scripts/on-events/api.js';
 import type { FunctionSource } from '../syncConfigs/db.js';
 import type { CLIDeployFlowConfig, OnEventScriptsByProvider } from './incomingFlow.js';
 import type { SyncDeploymentResult } from './index.js';
 import type { JSONSchema7 } from 'json-schema';
-export type PostDeployConfirmation = Endpoint<{
+export type PostDeployConfirmation = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/sync/deploy/confirmation';
     Body: {
@@ -19,7 +24,8 @@ export type PostDeployConfirmation = Endpoint<{
     };
     Success: ScriptDifferences;
 }>;
-export type PostDeploy = Endpoint<{
+export type PostDeploy = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deployed', 'environment'>;
     Method: 'POST';
     Path: '/sync/deploy';
     Body: {
@@ -36,7 +42,11 @@ export type PostDeploy = Endpoint<{
     };
     Success: SyncDeploymentResult[];
 }>;
-export type PostDeployInternal = Endpoint<{
+export type PostDeployInternal = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/sync/deploy/internal';
     Querystring: {

package/dist/environment/api/index.d.ts

@@ -1,5 +1,6 @@
 import type { ApiKeyScope } from '../../api-keys/scopes.js';
-import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
+import type { ApiEndpoint, ApiError, ApiTimestamps } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
 import type { ApiPlan } from '../../plans/http.api.js';
 import type { DBEnvironment, DBExternalWebhook } from '../db.js';
 import type { ApiEnvironmentVariable } from '../variable/api.js';
@@ -8,14 +9,19 @@ export type ApiEnvironment = Merge<DBEnvironment, {
     callback_url: string;
 } & ApiTimestamps>;
 export type ApiWebhooks = Omit<DBExternalWebhook, 'id' | 'environment_id' | 'created_at' | 'updated_at'>;
-export type GetEnvironments = Endpoint<{
+export type GetEnvironments = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/environments';
     Success: {
         data: Pick<DBEnvironment, 'name' | 'is_production'>[];
     };
 }>;
-export type PostEnvironment = Endpoint<{
+export type PostEnvironment = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'created', 'account'>;
     Method: 'POST';
     Path: '/api/v1/environments';
     Body: {
@@ -25,7 +31,11 @@ export type PostEnvironment = Endpoint<{
         data: Pick<DBEnvironment, 'id' | 'name'>;
     };
 }>;
-export type GetEnvironment = Endpoint<{
+export type GetEnvironment = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/environments/current';
     Success: {
@@ -43,7 +53,8 @@ export type GetEnvironment = Endpoint<{
         };
     };
 }>;
-export type PatchEnvironment = Endpoint<{
+export type PatchEnvironment = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'updated', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/environments';
     Body: {
@@ -64,13 +75,18 @@ export type PatchEnvironment = Endpoint<{
     };
     Error: ApiError<'conflict' | 'cannot_toggle_prod_environment'>;
 }>;
-export type DeleteEnvironment = Endpoint<{
+export type DeleteEnvironment = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'deleted', 'environment'>;
     Method: 'DELETE';
     Path: '/api/v1/environments';
     Success: never;
     Error: ApiError<'cannot_delete_prod_environment'>;
 }>;
-export type GetPublicEnvironmentVariables = Endpoint<{
+export type GetPublicEnvironmentVariables = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/environment-variables';
     Success: {
@@ -78,7 +94,11 @@ export type GetPublicEnvironmentVariables = Endpoint<{
         value: string;
     }[];
 }>;
-export type ListApiKeys = Endpoint<{
+export type ListApiKeys = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/environment/api-keys';
     Success: {
@@ -92,7 +112,8 @@ export type ListApiKeys = Endpoint<{
         }[];
     };
 }>;
-export type CreateApiKey = Endpoint<{
+export type CreateApiKey = ApiEndpoint<{
+    Audit: AuditPolicy<'api_key', 'created', 'environment'>;
     Method: 'POST';
     Path: '/api/v1/environment/api-keys';
     Body: {
@@ -110,7 +131,8 @@ export type CreateApiKey = Endpoint<{
     };
     Error: ApiError<'conflict' | 'resource_capped'>;
 }>;
-export type DeleteApiKey = Endpoint<{
+export type DeleteApiKey = ApiEndpoint<{
+    Audit: AuditPolicy<'api_key', 'deleted', 'environment'>;
     Method: 'DELETE';
     Path: '/api/v1/environment/api-keys/:keyId';
     Params: {
@@ -120,7 +142,8 @@ export type DeleteApiKey = Endpoint<{
         success: true;
     };
 }>;
-export type PatchApiKey = Endpoint<{
+export type PatchApiKey = ApiEndpoint<{
+    Audit: AuditPolicy<'api_key', 'updated', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/environment/api-keys/:keyId';
     Params: {

package/dist/environment/api/otlp.d.ts

@@ -1,9 +1,13 @@
-import type { ApiError, Endpoint } from '../../api.js';
+import type { ApiEndpoint, ApiError } from '../../api.js';
 export interface OtlpSettings {
     endpoint: string;
     headers: Record<string, string>;
 }
-export type UpdateOtlpSettings = Endpoint<{
+export type UpdateOtlpSettings = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Querystring: {
         env: string;

package/dist/environment/api/webhook.d.ts

@@ -1,5 +1,7 @@
-import type { Endpoint } from '../../api.js';
-export type PatchWebhook = Endpoint<{
+import type { ApiEndpoint } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
+export type PatchWebhook = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'webhook_urls_changed', 'environment'>;
     Method: 'PATCH';
     Querystring: {
         env: string;

package/dist/environment/variable/api.d.ts

@@ -1,7 +1,9 @@
-import type { Endpoint } from '../../api.js';
+import type { ApiEndpoint } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
 import type { DBEnvironmentVariable } from '../db.js';
 export type ApiEnvironmentVariable = Pick<DBEnvironmentVariable, 'name' | 'value'>;
-export type PostEnvironmentVariables = Endpoint<{
+export type PostEnvironmentVariables = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'variables_changed', 'environment'>;
     Method: 'POST';
     Path: '/api/v1/environments/variables';
     Querystring: {

package/dist/flow/http.api.d.ts

@@ -1,6 +1,8 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
 import type { ScriptTypeLiteral } from '../nangoYaml/index.js';
-export type PutUpgradePreBuiltFlow = Endpoint<{
+export type PutUpgradePreBuiltFlow = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'upgraded', 'environment'>;
     Method: 'PUT';
     Path: '/api/v1/flows/pre-built/upgrade';
     Querystring: {
@@ -20,7 +22,8 @@ export type PutUpgradePreBuiltFlow = Endpoint<{
         success: true;
     };
 }>;
-export type PostPreBuiltDeploy = Endpoint<{
+export type PostPreBuiltDeploy = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deployed', 'environment'>;
     Method: 'POST';
     Path: '/api/v1/flows/pre-built/deploy';
     Querystring: {
@@ -38,7 +41,8 @@ export type PostPreBuiltDeploy = Endpoint<{
         };
     };
 }>;
-export type PatchFlowEnable = Endpoint<{
+export type PatchFlowEnable = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'enabled', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/enable';
     Querystring: {
@@ -60,7 +64,8 @@ export type PatchFlowEnable = Endpoint<{
         };
     };
 }>;
-export type PatchFlowDisable = Endpoint<{
+export type PatchFlowDisable = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'disabled', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/disable';
     Querystring: {
@@ -82,7 +87,8 @@ export type PatchFlowDisable = Endpoint<{
         };
     };
 }>;
-export type PatchFlowFrequency = Endpoint<{
+export type PatchFlowFrequency = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'frequency_changed', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/frequency';
     Querystring: {
@@ -105,7 +111,11 @@ export type PatchFlowFrequency = Endpoint<{
         };
     };
 }>;
-export type GetFlowDownload = Endpoint<{
+export type GetFlowDownload = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/flows/:id/download';
     Querystring: {