@nangohq/types 0.71.2 → 0.71.4

package/dist/record/api.d.ts

@@ -1,4 +1,4 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
 export type RecordLastAction = 'ADDED' | 'UPDATED' | 'DELETED' | 'added' | 'updated' | 'deleted';
 export type CombinedFilterAction = `${RecordLastAction},${RecordLastAction}`;
 export interface RecordMetadata {
@@ -21,7 +21,11 @@ export type MergingStrategy = {
     cursor?: string | undefined;
 };
 export type CursorOffset = 'first' | 'last';
-export type GetPublicRecords = Endpoint<{
+export type GetPublicRecords = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: `/records`;
     Headers: {
@@ -44,7 +48,11 @@ export type GetPublicRecords = Endpoint<{
         records: NangoRecord[];
     };
 }>;
-export type PatchPublicPruneRecords = Endpoint<{
+export type PatchPublicPruneRecords = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'PATCH';
     Path: `/records/prune`;
     Headers: {
@@ -70,7 +78,11 @@ export interface ConnectionRecordModel {
     size_bytes: number;
     updated_at: string;
 }
-export type GetConnectionRecordModels = Endpoint<{
+export type GetConnectionRecordModels = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/connections/:connectionId/records/models';
     Params: {
@@ -84,7 +96,11 @@ export type GetConnectionRecordModels = Endpoint<{
         data: ConnectionRecordModel[];
     };
 }>;
-export type GetConnectionRecords = Endpoint<{
+export type GetConnectionRecords = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/connections/:connectionId/records';
     Params: {

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

@@ -1,4 +1,4 @@
-import type { Endpoint } from '../api.js';
+import type { ApiEndpoint } from '../api.js';
 import type { StandardNangoConfig } from '../flow/index.js';
 export interface OpenAIFunction {
     name: string;
@@ -12,7 +12,11 @@ export interface OpenAIFunction {
         required: string[];
     };
 }
-export type GetPublicScriptsConfig = Endpoint<{
+export type GetPublicScriptsConfig = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: `/scripts/config`;
     Query: {

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

@@ -1,5 +1,7 @@
-import type { Endpoint } from '../api.js';
-export type PostStripeCollectPayment = Endpoint<{
+import type { ApiEndpoint } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
+export type PostStripeCollectPayment = ApiEndpoint<{
+    Audit: AuditPolicy<'billing', 'payment_method_added', 'account'>;
     Method: 'POST';
     Path: '/api/v1/stripe/payment_methods';
     Success: {
@@ -12,14 +14,19 @@ export interface StripePaymentMethod {
     id: string;
     last4: string;
 }
-export type GetStripePaymentMethods = Endpoint<{
+export type GetStripePaymentMethods = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/stripe/payment_methods';
     Success: {
         data: StripePaymentMethod[];
     };
 }>;
-export type DeleteStripePayment = Endpoint<{
+export type DeleteStripePayment = ApiEndpoint<{
+    Audit: AuditPolicy<'billing', 'payment_method_removed', 'account'>;
     Method: 'DELETE';
     Path: '/api/v1/stripe/payment_methods';
     Querystring: {
@@ -31,7 +38,11 @@ export type DeleteStripePayment = Endpoint<{
         };
     };
 }>;
-export type PostStripeWebhooks = Endpoint<{
+export type PostStripeWebhooks = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'POST';
     Path: '/api/v1/stripe/webhooks';
     Body: any;

package/dist/sync/api.d.ts

@@ -1,6 +1,11 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
 import type { ReportedSyncJobStatus } from './index.js';
-export type PostPublicTrigger = Endpoint<{
+export type PostPublicTrigger = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/sync/trigger';
     Body: {
@@ -26,7 +31,8 @@ export type PostPublicTrigger = Endpoint<{
     };
     Error: ApiError<'missing_provider_config_key' | 'unknown_provider_config' | 'unknown_connection' | 'no_syncs_found'>;
 }>;
-export type PostSyncVariant = Endpoint<{
+export type PostSyncVariant = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'variant_created', 'environment'>;
     Method: 'POST';
     Path: '/sync/:name/variant/:variant';
     Body: {
@@ -44,7 +50,8 @@ export type PostSyncVariant = Endpoint<{
         variant: string;
     };
 }>;
-export type DeleteSyncVariant = Endpoint<{
+export type DeleteSyncVariant = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'variant_deleted', 'environment'>;
     Method: 'DELETE';
     Path: '/sync/:name/variant/:variant';
     Body: {
@@ -60,7 +67,8 @@ export type DeleteSyncVariant = Endpoint<{
         success: boolean;
     };
 }>;
-export type PutPublicSyncConnectionFrequency = Endpoint<{
+export type PutPublicSyncConnectionFrequency = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'frequency_changed', 'environment'>;
     Method: 'PUT';
     Path: '/sync/update-connection-frequency';
     Body: {
@@ -75,7 +83,8 @@ export type PutPublicSyncConnectionFrequency = Endpoint<{
     };
     Error: ApiError<'unknown_connection' | 'unknown_sync'>;
 }>;
-export type PostPublicSyncPause = Endpoint<{
+export type PostPublicSyncPause = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'paused', 'environment'>;
     Method: 'POST';
     Path: '/sync/pause';
     Body: {
@@ -91,7 +100,8 @@ export type PostPublicSyncPause = Endpoint<{
     };
     Error: ApiError<'no_syncs_found' | 'unknown_connection' | 'unknown_provider_config'>;
 }>;
-export type PostPublicSyncStart = Endpoint<{
+export type PostPublicSyncStart = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'started', 'environment'>;
     Method: 'POST';
     Path: '/sync/start';
     Body: {
@@ -107,7 +117,11 @@ export type PostPublicSyncStart = Endpoint<{
     };
     Error: ApiError<'no_syncs_found' | 'unknown_connection' | 'unknown_provider_config'>;
 }>;
-export type GetPublicSyncStatus = Endpoint<{
+export type GetPublicSyncStatus = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/sync/status';
     Querystring: {

package/dist/team/api.d.ts

@@ -1,10 +1,15 @@
-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 { DBInvitation } from '../invitations/db.js';
 import type { ApiUser } from '../user/api.js';
 import type { Role } from '../user/db.js';
 import type { DBTeam } from './db.js';
 import type { Merge } from 'type-fest';
-export type GetTeam = Endpoint<{
+export type GetTeam = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/team';
     Querystring: {
@@ -13,15 +18,20 @@ export type GetTeam = Endpoint<{
     Success: {
         data: {
             account: ApiTeam;
-            users: ApiUser[];
+            users: ApiTeamUser[];
             invitedUsers: ApiInvitation[];
             isAdminTeam: boolean;
+            mfaFeatureEnabled: boolean;
         };
     };
 }>;
+export interface ApiTeamUser extends ApiUser {
+    mfaEnabled: boolean;
+}
 export type ApiInvitation = Merge<Omit<DBInvitation, 'token'>, ApiTimestamps>;
 export type ApiTeam = Merge<DBTeam, ApiTimestamps>;
-export type PutTeam = Endpoint<{
+export type PutTeam = ApiEndpoint<{
+    Audit: AuditPolicy<'team', 'updated', 'account'>;
     Method: 'PUT';
     Path: '/api/v1/team';
     Querystring: {
@@ -34,7 +44,8 @@ export type PutTeam = Endpoint<{
         data: ApiTeam;
     };
 }>;
-export type DeleteTeamUser = Endpoint<{
+export type DeleteTeamUser = ApiEndpoint<{
+    Audit: AuditPolicy<'member', 'removed', 'account'>;
     Method: 'DELETE';
     Path: '/api/v1/team/users/:id';
     Querystring: {
@@ -50,7 +61,8 @@ export type DeleteTeamUser = Endpoint<{
         };
     };
 }>;
-export type PatchTeamUser = Endpoint<{
+export type PatchTeamUser = ApiEndpoint<{
+    Audit: AuditPolicy<'member', 'role_changed', 'account'>;
     Method: 'PATCH';
     Path: '/api/v1/team/users/:id';
     Querystring: {

package/dist/user/api.d.ts

@@ -1,6 +1,11 @@
-import type { Endpoint } from '../api.js';
+import type { ApiEndpoint, Endpoint } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
 import type { Role } from './db.js';
-export type GetUser = Endpoint<{
+export type GetUser = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: `/api/v1/user`;
     Success: {
@@ -17,7 +22,8 @@ export type InternalGetUsers = Endpoint<{
         data: ApiUser[];
     };
 }>;
-export type PatchUser = Endpoint<{
+export type PatchUser = ApiEndpoint<{
+    Audit: AuditPolicy<'user', 'updated', 'account'>;
     Method: 'PATCH';
     Path: `/api/v1/user`;
     Body: {
@@ -42,7 +48,8 @@ export type ApiUserWithPermissions = ApiUser & {
     role: Role;
     permissions: AllowedPermissions;
 };
-export type PutUserPassword = Endpoint<{
+export type PutUserPassword = ApiEndpoint<{
+    Audit: AuditPolicy<'app_auth', 'password_changed', 'account'>;
     Method: 'PUT';
     Path: `/api/v1/user/password`;
     Body: {

package/dist/user/db.d.ts

@@ -15,5 +15,7 @@ export interface DBUser extends Timestamps {
     email_verification_token_expires_at: Date | null;
     uuid: string;
     getting_started_closed: boolean;
+    account_discovery_pending: boolean;
+    account_invitation_requested_at: Date | null;
     role: Role;
 }

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.71.2",
+    "version": "0.71.4",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",

package/dist/functions/capabilities.d.ts

@@ -1,7 +0,0 @@
-export interface FunctionCapabilities {
-    usesRecords: boolean;
-    usesCheckpoints: boolean;
-    usesMetadata: boolean;
-    usesOutbound: boolean;
-    usesInvoke: boolean;
-}