@nangohq/types 0.71.5 → 0.71.6

package/dist/account/api.d.ts

@@ -5,6 +5,7 @@ import type { MFACredential } from '../mfa/credential.js';
 import type { ApiUser } from '../user/api.js';
 export interface AccountApiKey {
     id: number;
+    uuid: string;
     display_name: string;
     scopes: AccountApiKeyScope[];
     secret: string;

package/dist/agent/toolSearch.d.ts

@@ -0,0 +1,34 @@
+import type { JSONSchema7 } from 'json-schema';
+export type AgentSessionToolConnectionState = {
+    readonly status: 'connected';
+    readonly connection_id: string;
+} | {
+    readonly status: 'not_connected';
+};
+/** `schema` carries the arguments, `none` means there are none, `unavailable` means they could not be read. */
+export type AgentSessionToolInput = {
+    readonly kind: 'schema';
+    readonly schema: JSONSchema7;
+} | {
+    readonly kind: 'none';
+} | {
+    readonly kind: 'unavailable';
+};
+export interface AgentSessionToolMatch {
+    /** What to pass to nango_execute. Names are sanitised and clipped, so use it as given. */
+    readonly tool: string;
+    readonly integration: string;
+    readonly action: string;
+    readonly provider: string;
+    readonly description: string;
+    /** Whether the tool is in the agent's tool list, under the same name. */
+    readonly listed: boolean;
+    readonly connection: AgentSessionToolConnectionState;
+    /** Only on a best match. A soft match is a lead to narrow down, not something to call yet. */
+    readonly input?: AgentSessionToolInput;
+}
+export interface AgentSessionToolSearchResult {
+    readonly guidance: string;
+    readonly matches: AgentSessionToolMatch[];
+    readonly related: AgentSessionToolMatch[];
+}

package/dist/api-keys/auth.d.ts

@@ -23,6 +23,8 @@ export interface ApiKeyAuthDetails {
     source: Exclude<ApiKeyAuthSource, 'connect_session'>;
     scopes?: string[];
     apiKeyId?: number;
+    /** Public identifier of a customer key; absent for the other auth sources, which have no key row. */
+    apiKeyUuid?: string;
     apiKeyDisplayName?: string;
     purpose?: 'dryrun' | 'deploy';
     dryrunId?: string;

package/dist/audit-trail/api.d.ts

@@ -1,12 +1,13 @@
 import type { ApiEndpoint, ApiError } from '../api.js';
-import type { AuditAction, AuditActor, AuditContext, AuditOutcome, AuditPolicy, AuditResource, AuditTarget, AuditTrailVersion, AuditVia } from './event.js';
+import type { AuditAction, AuditActor, AuditContext, AuditOutcome, AuditPolicy, AuditResource, AuditScope, AuditTarget, AuditTrailVersion, AuditVia } from './event.js';
 export interface ApiAuditTrailEvent {
     id: string;
     version: AuditTrailVersion;
     occurredAt: string;
     accountId: number;
+    scope: AuditScope;
     environment: {
-        id: number;
+        id: string;
         display: string;
     } | null;
     actor: AuditActor;

package/dist/audit-trail/event.d.ts

@@ -1,29 +1,101 @@
+import type { ApiKeyUpdatedMetadata, AppAuthLoginMetadata, AuditTrailFiltersMetadata, AuditTrailQueriedMetadata, BillingPaymentMethodRemovedMetadata, BillingPlanChangedMetadata, BillingSpendAlertChangedMetadata, ConnectionMetadata, ConnectionUpdatedMetadata, EnvironmentCreatedMetadata, EnvironmentUpdatedMetadata, EnvironmentVariablesChangedMetadata, EnvironmentWebhookMetadata, FunctionDeletedMetadata, FunctionDeployedMetadata, FunctionUpgradedMetadata, IntegrationProviderMetadata, IntegrationUpdatedMetadata, MemberInvitedMetadata, MemberRoleChangedMetadata, MfaVerifiedMetadata, SyncBaseMetadata, SyncFrequencyChangedMetadata, SyncTriggeredMetadata, SyncVariantMetadata, TeamUpdatedMetadata, UserUpdatedMetadata } from './metadata.js';
 export type AuditTrailVersion = '2026-07-16';
-export type AuditActorType = 'user' | 'api_key' | 'connect_session' | 'anonymous' | 'unknown';
+export type AuditActorType = 'user' | 'api_key' | 'public_key' | 'connect_session' | 'anonymous' | 'unknown';
 export type AuditOutcome = 'success' | 'failure' | 'denied';
 export type AuditViaType = 'impersonation';
 export type AuditInterface = 'api' | 'mcp';
 interface AuditEventTable {
-    connection: 'created' | 'updated' | 'metadata_updated' | 'refreshed' | 'deleted';
-    sync: 'enabled' | 'disabled' | 'paused' | 'started' | 'triggered' | 'cancelled' | 'frequency_changed' | 'variant_created' | 'variant_deleted';
-    function: 'deployed' | 'upgraded' | 'deleted';
-    integration: 'created' | 'updated' | 'deleted';
-    api_key: 'created' | 'updated' | 'deleted';
-    member: 'invited' | 'invite_accepted' | 'invite_declined' | 'invite_revoked' | 'role_changed' | 'removed';
-    team: 'updated';
-    user: 'updated';
-    environment: 'created' | 'updated' | 'variables_changed' | 'webhook_urls_changed' | 'webhook_signing_key_rotated' | 'deleted';
-    app_auth: 'login' | 'logout' | 'signup' | 'password_changed' | 'password_reset';
-    mfa: 'enrolled' | 'enabled' | 'disabled' | 'verified' | 'recovery_regenerated';
-    billing: 'plan_changed' | 'trial_extended' | 'details_changed' | 'payment_method_added' | 'payment_method_removed' | 'spend_alert_changed' | 'spend_alert_removed';
-    audit_trail: 'exported' | 'queried';
+    connection: {
+        created: ConnectionMetadata;
+        updated: ConnectionUpdatedMetadata;
+        metadata_updated: ConnectionMetadata;
+        refreshed: ConnectionMetadata;
+        deleted: ConnectionMetadata;
+    };
+    sync: {
+        enabled: SyncBaseMetadata;
+        disabled: SyncBaseMetadata;
+        paused: SyncBaseMetadata;
+        started: SyncBaseMetadata;
+        triggered: SyncTriggeredMetadata;
+        cancelled: SyncBaseMetadata;
+        frequency_changed: SyncFrequencyChangedMetadata;
+        variant_created: SyncVariantMetadata;
+        variant_deleted: SyncVariantMetadata;
+    };
+    function: {
+        deployed: FunctionDeployedMetadata;
+        upgraded: FunctionUpgradedMetadata;
+        deleted: FunctionDeletedMetadata;
+    };
+    integration: {
+        created: IntegrationProviderMetadata;
+        updated: IntegrationProviderMetadata & IntegrationUpdatedMetadata;
+        deleted: IntegrationProviderMetadata;
+    };
+    api_key: {
+        created: ApiKeyUpdatedMetadata;
+        updated: ApiKeyUpdatedMetadata;
+        deleted: never;
+    };
+    member: {
+        invited: MemberInvitedMetadata;
+        invite_accepted: never;
+        invite_declined: never;
+        invite_revoked: never;
+        role_changed: MemberRoleChangedMetadata;
+        removed: never;
+    };
+    team: {
+        updated: TeamUpdatedMetadata;
+    };
+    user: {
+        updated: UserUpdatedMetadata;
+    };
+    environment: {
+        created: EnvironmentCreatedMetadata;
+        updated: EnvironmentUpdatedMetadata;
+        variables_changed: EnvironmentVariablesChangedMetadata;
+        webhook_urls_changed: EnvironmentWebhookMetadata;
+        webhook_signing_key_rotated: never;
+        deleted: never;
+    };
+    app_auth: {
+        login: AppAuthLoginMetadata;
+        logout: never;
+        signup: never;
+        password_changed: never;
+        password_reset: never;
+    };
+    mfa: {
+        enrolled: never;
+        enabled: never;
+        disabled: never;
+        verified: MfaVerifiedMetadata;
+        recovery_regenerated: never;
+    };
+    billing: {
+        plan_changed: BillingPlanChangedMetadata;
+        trial_extended: never;
+        details_changed: never;
+        payment_method_added: never;
+        payment_method_removed: BillingPaymentMethodRemovedMetadata;
+        spend_alert_changed: BillingSpendAlertChangedMetadata;
+        spend_alert_removed: never;
+    };
+    audit_trail: {
+        exported: AuditTrailFiltersMetadata;
+        queried: AuditTrailQueriedMetadata;
+    };
 }
 export type AuditResource = keyof AuditEventTable;
-export type AuditActionOf<R extends AuditResource> = AuditEventTable[R];
+export type AuditActionOf<R extends AuditResource> = R extends AuditResource ? keyof AuditEventTable[R] & string : never;
 export type AuditAction = AuditActionOf<AuditResource>;
 export type AuditEventKey = {
-    [R in AuditResource]: `${R}.${AuditEventTable[R]}`;
+    [R in AuditResource]: `${R}.${AuditActionOf<R>}`;
 }[AuditResource];
+/** The metadata an action may carry. `never` for the actions that carry none. */
+export type AuditMetadataFor<R extends AuditResource, A> = A extends keyof AuditEventTable[R] ? AuditEventTable[R][A] : never;
 export type AuditScope = 'account' | 'environment';
 export type AuditTargetType = 'connection' | 'sync' | 'function' | 'integration' | 'api_key' | 'member' | 'team' | 'user' | 'environment';
 export interface AuditActor {
@@ -70,4 +142,35 @@ export type EndpointAudit = AuditPolicy | NoAudit<string>;
 export type SerializedAuditEvent = {
     event: string;
 };
+export type AuditResourceAction = {
+    [R in AuditResource]: {
+        [A in AuditActionOf<R>]: [AuditMetadataFor<R, A>] extends [never] ? {
+            resource: R;
+            action: A;
+        } : {
+            resource: R;
+            action: A;
+            metadata?: AuditMetadataFor<R, A>;
+        };
+    }[AuditActionOf<R>];
+}[AuditResource];
+interface AuditEventCommon {
+    occurredAt: string;
+    accountId: number;
+    scope: AuditScope;
+    environment: {
+        id: string;
+        display: string;
+    } | null;
+    actor: AuditActor;
+    via?: AuditVia[];
+    targets: AuditTarget[];
+    context: AuditContext;
+    outcome: AuditOutcome;
+}
+export type AuditEvent = AuditEventCommon & AuditResourceAction;
+export type StoredAuditEvent = AuditEvent & {
+    id: string;
+    version: AuditTrailVersion;
+};
 export {};

package/dist/audit-trail/metadata.d.ts

@@ -0,0 +1,99 @@
+import type { FunctionSource } from '../syncConfigs/db.js';
+export interface ConnectionMetadata {
+    providerConfigKey?: string;
+}
+export interface ConnectionUpdatedMetadata {
+    providerConfigKey?: string;
+    changedFields?: string[];
+}
+export interface IntegrationProviderMetadata {
+    provider?: string;
+}
+export interface IntegrationUpdatedMetadata {
+    changedFields?: string[];
+}
+export interface EnvironmentCreatedMetadata {
+    name?: string;
+}
+export interface AuditTrailFiltersMetadata {
+    from?: string;
+    to?: string;
+    resources?: string[];
+    actions?: string[];
+}
+export interface AuditTrailQueriedMetadata extends AuditTrailFiltersMetadata {
+    continued?: boolean;
+}
+export interface MemberInvitedMetadata {
+    role?: string;
+}
+export interface FunctionDeployedMetadata {
+    source?: FunctionSource;
+    type?: string;
+}
+export interface FunctionUpgradedMetadata {
+    upgradeVersion?: string;
+}
+export interface FunctionDeletedMetadata {
+    type?: string;
+}
+export interface ApiKeyUpdatedMetadata {
+    displayName?: string;
+    scopes?: string[];
+}
+export interface SyncBaseMetadata {
+    providerConfigKey?: string;
+    connectionId?: string;
+}
+export interface SyncFrequencyChangedMetadata extends SyncBaseMetadata {
+    frequency?: string;
+}
+export interface SyncVariantMetadata extends SyncBaseMetadata {
+    variant?: string;
+}
+export interface SyncTriggeredMetadata extends SyncBaseMetadata {
+    reset?: boolean;
+    emptyCache?: boolean;
+}
+export interface MemberRoleChangedMetadata {
+    fromRole?: string;
+    toRole?: string;
+}
+export interface TeamUpdatedMetadata {
+    name?: string;
+}
+export interface UserUpdatedMetadata {
+    name?: string;
+    gettingStartedClosed?: boolean;
+}
+export interface EnvironmentUpdatedMetadata {
+    name?: string;
+    changedFields?: string[];
+}
+export interface EnvironmentVariablesChangedMetadata {
+    variableCount?: number;
+    variableNames?: string[];
+}
+export interface EnvironmentWebhookMetadata {
+    changedFields?: string[];
+    primaryUrl?: string;
+    secondaryUrl?: string;
+}
+export interface BillingPlanChangedMetadata {
+    fromPlan?: string;
+    toPlan?: string;
+}
+export type AppAuthLoginMethod = 'local' | 'sso' | 'managed';
+export interface AppAuthLoginMetadata {
+    mfaRequired?: boolean;
+    method?: AppAuthLoginMethod;
+}
+export interface BillingPaymentMethodRemovedMetadata {
+    paymentMethodId?: string;
+}
+export interface MfaVerifiedMetadata {
+    method?: 'totp' | 'recovery_code';
+}
+export interface BillingSpendAlertChangedMetadata {
+    thresholdInCents?: number;
+}

package/dist/auth/api.d.ts

@@ -20,7 +20,7 @@ export interface AuthModes {
     AwsSigV4: 'AWS_SIGV4';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
-export type AuthOperationType = 'creation' | 'override' | 'refresh' | 'unknown';
+export type AuthOperationType = 'creation' | 'override' | 'refresh' | 'deletion' | 'unknown';
 export interface OAuthAuthorizationMethod {
     BODY: 'body';
     HEADER: 'header';

package/dist/billing/types.d.ts

@@ -32,16 +32,16 @@ export interface BillingClient {
     applyPendingChanges: (opts: {
         pendingChangeId: string;
         /**
-         * Stripe PaymentIntent ID, used to cross-reference the payment in Orb.
+         * Payment collected up front.
+         *
+         * Omitted for a plan billed fully in arrears, where nothing is collected when the change is applied.
          */
-        paymentExternalId: string;
-        /**
-         * Amount collected via Stripe in dollars (e.g. "25.00"). Orb uses this
-         * to credit the customer the difference vs. the actual invoice amount,
-         * so overcharges (e.g. when falling back to the base fee) are corrected
-         * automatically. No credit is issued if the amounts match exactly.
-         */
-        amountCollected: string;
+        payment?: {
+            /** The external payment ID; for Stripe, it's the PaymentIntent ID. */
+            externalId: string;
+            /** Amount collected in dollars. */
+            amountCollected: string;
+        } | undefined;
     }) => Promise<Result<BillingSubscription>>;
     cancelPendingChanges: (opts: {
         pendingChangeId: string;
@@ -126,7 +126,7 @@ export interface BreakdownDimensions {
     webhook_forwards: 'environment_id' | 'integration_id' | 'connection_id' | 'success';
     records: 'environment_id' | 'integration_id' | 'connection_id' | 'model';
     connections: 'environment_id' | 'integration_id';
-    data_transfer: 'environment_id' | 'integration_id' | 'connection_id' | 'package' | 'callsite';
+    data_transfer: 'environment_id' | 'integration_id' | 'connection_id' | 'source';
 }
 export type DimensionFor<M extends UsageMetric> = 'none' | BreakdownDimensions[M];
 export interface GetBillingUsageOpts {

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

@@ -28,7 +28,7 @@ export type PostEnvironment = ApiEndpoint<{
         name: string;
     };
     Success: {
-        data: Pick<DBEnvironment, 'id' | 'name'>;
+        data: Pick<DBEnvironment, 'id' | 'uuid' | 'name'>;
     };
     Error: ApiError<'conflict' | 'resource_capped' | 'invalid_is_prod_flag'>;
 }>;
@@ -50,16 +50,16 @@ export type PostPublicEnvironment = ApiEndpoint<{
         }[] | undefined;
     };
     Success: {
-        data: Pick<DBEnvironment, 'id' | 'name'>;
+        data: Pick<DBEnvironment, 'id' | 'uuid' | 'name'>;
     };
     Error: ApiError<'conflict' | 'resource_capped' | 'invalid_is_prod_flag'>;
 }>;
 export type DeletePublicEnvironment = ApiEndpoint<{
     Audit: AuditPolicy<'environment', 'deleted', 'account'>;
     Method: 'DELETE';
-    Path: '/environments/:environmentId';
+    Path: '/environments/:environmentUuid';
     Params: {
-        environmentId: number;
+        environmentUuid: string;
     };
     Success: never;
     Error: ApiError<'cannot_delete_prod_environment'>;
@@ -159,6 +159,7 @@ export type ListApiKeys = ApiEndpoint<{
     Success: {
         data: {
             id: number;
+            uuid: string;
             display_name: string;
             scopes: ApiKeyScope[];
             secret: string;
@@ -178,6 +179,7 @@ export type CreateApiKey = ApiEndpoint<{
     Success: {
         data: {
             id: number;
+            uuid: string;
             display_name: string;
             scopes: ApiKeyScope[];
             secret: string;
@@ -189,14 +191,17 @@ export type CreateApiKey = ApiEndpoint<{
 export type PostPublicApiKey = ApiEndpoint<{
     Audit: AuditPolicy<'api_key', 'created', 'environment'>;
     Method: 'POST';
-    Path: '/environment/api-keys';
+    Path: '/environments/:environmentUuid/api-keys';
+    Params: {
+        environmentUuid: string;
+    };
     Body: {
-        environment_id: number;
         display_name: string;
     };
     Success: {
         data: {
             id: number;
+            uuid: string;
             display_name: string;
             scopes: ApiKeyScope[];
             secret: string;
@@ -208,10 +213,10 @@ export type PostPublicApiKey = ApiEndpoint<{
 export type DeletePublicApiKey = ApiEndpoint<{
     Audit: AuditPolicy<'api_key', 'deleted', 'environment'>;
     Method: 'DELETE';
-    Path: '/environment/api-keys';
-    Body: {
-        environment_id: number;
-        key_id: number;
+    Path: '/environments/:environmentUuid/api-keys/:keyUuid';
+    Params: {
+        environmentUuid: string;
+        keyUuid: string;
     };
     Success: {
         success: true;

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

@@ -15,6 +15,7 @@ export type PatchWebhook = ApiEndpoint<{
         on_auth_refresh_error?: boolean | undefined;
         on_sync_error?: boolean | undefined;
         on_async_action_completion?: boolean | undefined;
+        on_connection_deletion?: boolean | undefined;
     };
     Success: {
         success: boolean;

package/dist/environment/db.d.ts

@@ -63,6 +63,7 @@ export interface DBExternalWebhook extends Timestamps {
     on_auth_refresh_error: boolean;
     on_sync_error: boolean;
     on_async_action_completion: boolean;
+    on_connection_deletion: boolean;
 }
 export interface DBAPISecret extends Timestamps {
     id: number;
@@ -77,6 +78,7 @@ export interface DBAPISecret extends Timestamps {
 export type CustomerKeyType = 'api' | 'webhook_signing';
 export interface DBCustomerKey extends Timestamps {
     id: number;
+    uuid: string;
     account_id: number;
     key_type: CustomerKeyType;
     display_name: string;

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export type * from './api.js';
 export type * from './api.endpoints.js';
 export type * from './audit-trail/api.js';
 export type * from './audit-trail/event.js';
+export type * from './audit-trail/metadata.js';
 export type * from './gettingStarted/db.js';
 export type * from './gettingStarted/dto.js';
 export type * from './gettingStarted/api.js';
@@ -15,6 +16,7 @@ export type * from './agent/api.js';
 export type * from './agent/connections.js';
 export type * from './agent/mcp.api.js';
 export type * from './agent/session.js';
+export type * from './agent/toolSearch.js';
 export type * from './agent/toolset.js';
 export type * from './admin/http.api.js';
 export type * from './account/api.js';

package/dist/logs/messages.d.ts

@@ -50,7 +50,7 @@ export interface OperationAdmin {
 }
 export interface OperationWebhook {
     type: 'webhook';
-    action: 'incoming' | 'forward' | 'sync' | 'connection_create' | 'connection_refresh';
+    action: 'incoming' | 'forward' | 'sync' | 'connection_create' | 'connection_refresh' | 'connection_delete';
 }
 export interface OperationDeploy {
     type: 'deploy';

package/dist/meta/api.d.ts

@@ -19,6 +19,7 @@ export type GetMeta = ApiEndpoint<{
             debugMode: boolean;
             gettingStartedClosed: boolean;
             auditTrail: boolean;
+            s26Pricing: boolean;
         };
     };
 }>;

package/dist/plans/db.d.ts

@@ -3,7 +3,7 @@ type FunctionRuntime = 'runner' | 'lambda';
 export interface DBPlan extends Timestamps {
     id: number;
     account_id: number;
-    name: 'free' | 'free-uncapped' | 'startup-deal' | 'starter-v2' | 'growth-v2' | 'enterprise' | 'enterprise-cloud-hosted' | 'starter' | 'growth' | 'starter-legacy' | 'scale-legacy' | 'growth-legacy';
+    name: 'free' | 'free-uncapped' | 'startup-deal' | 'pay-as-you-go' | 'starter-v2' | 'growth-v2' | 'enterprise' | 'enterprise-cloud-hosted' | 'starter' | 'growth' | 'starter-legacy' | 'scale-legacy' | 'growth-legacy';
     stripe_customer_id: string | null;
     stripe_payment_id: string | null;
     orb_customer_id: string | null;

package/dist/providers/provider.d.ts

@@ -220,6 +220,7 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
         recipient?: string;
         header?: Record<string, string>;
         payload?: Record<string, string>;
+        singleUse?: boolean;
     };
     assertion_option?: Record<string, SimplifiedJSONSchema>;
     token_expires_in_ms?: number;

package/dist/webhooks/api.d.ts

@@ -39,7 +39,8 @@ export type NangoSyncWebhookBody = NangoSyncWebhookBodySuccess | NangoSyncWebhoo
 export interface NangoAuthWebhookBodyBase extends NangoWebhookBase {
     type: 'auth';
     connectionId: string;
-    authMode: AuthModeType;
+    /** 'unknown' when the connection's integration could no longer be resolved (e.g. it was deleted). */
+    authMode: AuthModeType | 'unknown';
     providerConfigKey: string;
     provider: string;
     environment: string;

package/package.json

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