@nangohq/types 0.71.2 → 0.71.4

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

@@ -1,4 +1,4 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
 export type ConnectionQueryString = {
     connection_id?: string | undefined;
     params?: Record<string, any> | undefined;
@@ -34,7 +34,11 @@ export interface WebSocketConnectionResponseSuccess {
     private_key?: string | undefined;
 }
 type AuthErrors = ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'> | ApiError<'integration_not_allowed'> | ApiError<'invalid_connection'> | ApiError<'connection_test_failed'> | ApiError<'connection_validation_failed'>;
-export type PostPublicApiKeyAuthorization = Endpoint<{
+export type PostPublicApiKeyAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: {
         apiKey: string;
@@ -47,23 +51,11 @@ export type PostPublicApiKeyAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicAppStoreAuthorization = Endpoint<{
-    Method: 'POST';
-    Body: {
-        privateKeyId: string;
-        privateKey: string;
-        issuerId: string;
-        scope?: string | undefined;
+export type PostPublicBasicAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
     };
-    Querystring: ConnectionQueryString;
-    Params: {
-        providerConfigKey: string;
-    };
-    Path: '/app-store-auth/:providerConfigKey';
-    Error: AuthErrors;
-    Success: ConnectionResponseSuccess;
-}>;
-export type PostPublicBasicAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
         username: string;
@@ -77,7 +69,11 @@ export type PostPublicBasicAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicTbaAuthorization = Endpoint<{
+export type PostPublicTbaAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: {
         token_id: string;
@@ -94,7 +90,11 @@ export type PostPublicTbaAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicJwtAuthorization = Endpoint<{
+export type PostPublicJwtAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: Record<string, any>;
     Querystring: ConnectionQueryString;
@@ -105,7 +105,11 @@ export type PostPublicJwtAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicUnauthenticatedAuthorization = Endpoint<{
+export type PostPublicUnauthenticatedAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Querystring: ConnectionQueryString;
     Params: {
@@ -115,7 +119,11 @@ export type PostPublicUnauthenticatedAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicBillAuthorization = Endpoint<{
+export type PostPublicBillAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: {
         username: string;
@@ -131,7 +139,11 @@ export type PostPublicBillAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicTwoStepAuthorization = Endpoint<{
+export type PostPublicTwoStepAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: Record<string, any>;
     Querystring: ConnectionQueryString;
@@ -142,7 +154,11 @@ export type PostPublicTwoStepAuthorization = Endpoint<{
     Error: AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicSignatureAuthorization = Endpoint<{
+export type PostPublicSignatureAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: {
         username: string;
@@ -157,7 +173,11 @@ export type PostPublicSignatureAuthorization = Endpoint<{
     Success: ConnectionResponseSuccess;
 }>;
 type AwsSigV4AuthErrors = AuthErrors | ApiError<'invalid_aws_sigv4_config'> | ApiError<'missing_aws_sigv4_service'> | ApiError<'missing_aws_sigv4_sts_endpoint'> | ApiError<'missing_aws_sigv4_builtin_credentials'> | ApiError<'missing_aws_sigv4_region'> | ApiError<'aws_sigv4_sts_request_failed'>;
-export type PostPublicAwsSigV4Authorization = Endpoint<{
+export type PostPublicAwsSigV4Authorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: {
         role_arn: string;
@@ -171,7 +191,11 @@ export type PostPublicAwsSigV4Authorization = Endpoint<{
     Error: AwsSigV4AuthErrors;
     Success: ConnectionResponseSuccess;
 }>;
-export type PostPublicOauthOutboundAuthorization = Endpoint<{
+export type PostPublicOauthOutboundAuthorization = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Body: {
         username: string;

package/dist/authz/types.d.ts

@@ -1,6 +1,6 @@
 import type { Role } from '../user/db.js';
 export type Action = 'create' | 'read' | 'update' | 'delete' | '*';
-export type Resource = 'team' | 'team_member' | 'invite' | 'connect_ui_settings' | 'billing' | 'plan' | 'environment' | 'environment_production_flag' | 'environment_key' | 'environment_variable' | 'webhook' | 'integration' | 'connection' | 'flow' | 'sync_command' | 'secret_key' | 'connection_credential' | 'log' | '*';
+export type Resource = 'team' | 'team_member' | 'invite' | 'connect_ui_settings' | 'billing' | 'plan' | 'environment' | 'environment_production_flag' | 'environment_key' | 'environment_variable' | 'webhook' | 'integration' | 'connection' | 'flow' | 'sync_command' | 'secret_key' | 'connection_credential' | 'log' | 'audit_trail' | '*';
 export type Scope = 'production' | 'non-production' | 'global';
 export interface Permission {
     action: Action;

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

@@ -1,5 +1,9 @@
-import type { Endpoint } from '../api.js';
-export type PostOrbWebhooks = Endpoint<{
+import type { ApiEndpoint } from '../api.js';
+export type PostOrbWebhooks = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/api/v1/orb/webhooks';
     Body: any;

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,4 +1,5 @@
-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 { ApiKeyCredentials, ApiPublicAllAuthCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
 import type { EndUserInput } from '../../connect/api.js';
 import type { Tags } from '../../db.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;
@@ -137,7 +155,11 @@ export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id'
     tags: Tags;
     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: {
@@ -171,7 +194,8 @@ export type PatchPublicConnection = Endpoint<{
     };
     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: {
@@ -191,7 +215,8 @@ export type PatchConnection = Endpoint<{
     };
     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;