@nangohq/types 0.70.8 → 0.71.0

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

@@ -1,3 +1,3 @@
-export declare const API_KEY_SCOPES: readonly ["environment:*", "environment:integrations:list", "environment:integrations:list_credentials", "environment:integrations:list_functions", "environment:integrations:read", "environment:integrations:read_credentials", "environment:integrations:create", "environment:integrations:update", "environment:integrations:delete", "environment:integrations:*", "environment:connections:list", "environment:connections:list_credentials", "environment:connections:read", "environment:connections:read_credentials", "environment:connections:create", "environment:connections:update", "environment:connections:delete", "environment:connections:*", "environment:connect_sessions:write", "environment:syncs:read", "environment:syncs:execute", "environment:syncs:update", "environment:syncs:variant:create", "environment:syncs:variant:delete", "environment:syncs:*", "environment:functions:list", "environment:functions:read", "environment:functions:delete", "environment:functions:compile", "environment:functions:dryrun", "environment:functions:*", "environment:deploy", "environment:records:read", "environment:records:write", "environment:records:*", "environment:actions:execute", "environment:actions:*", "environment:proxy", "environment:variables:read", "environment:mcp"];
+export declare const API_KEY_SCOPES: readonly ["environment:*", "environment:integrations:list", "environment:integrations:list_credentials", "environment:integrations:list_functions", "environment:integrations:read", "environment:integrations:read_credentials", "environment:integrations:create", "environment:integrations:update", "environment:integrations:delete", "environment:integrations:*", "environment:connections:list", "environment:connections:list_credentials", "environment:connections:read", "environment:connections:read_credentials", "environment:connections:create", "environment:connections:update", "environment:connections:delete", "environment:connections:*", "environment:connect_sessions:write", "environment:syncs:read", "environment:syncs:execute", "environment:syncs:update", "environment:syncs:variant:create", "environment:syncs:variant:delete", "environment:syncs:*", "environment:functions:list", "environment:functions:read", "environment:functions:delete", "environment:functions:compile", "environment:functions:dryrun", "environment:functions:*", "environment:deploy", "environment:records:read", "environment:records:write", "environment:records:*", "environment:logs:read", "environment:actions:execute", "environment:actions:*", "environment:proxy", "environment:variables:read", "environment:mcp"];
 export type ApiKeyScope = (typeof API_KEY_SCOPES)[number];
 export declare const ALL_SCOPES: string[];

package/dist/api.endpoints.d.ts

@@ -3,10 +3,12 @@ import type { GetAsyncActionResult, GetPublicV1, PostInternalTriggerFunction, Po
 import type { PostImpersonate } from './admin/http.api.js';
 import type { EndpointMethod } from './api.js';
 import type { PostPublicApiKeyAuthorization, PostPublicAppStoreAuthorization, PostPublicAwsSigV4Authorization, PostPublicBasicAuthorization, PostPublicBillAuthorization, PostPublicJwtAuthorization, PostPublicOauthOutboundAuthorization, PostPublicSignatureAuthorization, PostPublicTbaAuthorization, PostPublicTwoStepAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api.js';
+import type { PostCliTelemetry } from './cli/api.js';
+import type { GetPublicClientMetadata } from './clientMetadata/http.api.js';
 import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect, PostPublicConnectTelemetry } from './connect/api.js';
-import type { GetConnectUISettings, PutConnectUISettings } from './connectUISettings/api.js';
-import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PatchPublicConnection, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
+import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PatchConnection, PatchPublicConnection, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata.js';
+import type { GetConnectUISettings, PutConnectUISettings } from './connectUISettings/api.js';
 import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api.js';
 import type { CreateApiKey, DeleteApiKey, DeleteEnvironment, GetEnvironment, GetEnvironments, ListApiKeys, PatchApiKey, PatchEnvironment, PostEnvironment } from './environment/api/index.js';
 import type { PatchWebhook } from './environment/api/webhook.js';
@@ -14,7 +16,7 @@ import type { PostEnvironmentVariables } from './environment/variable/api.js';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api.js';
 import type { DeleteIntegrationFunction, DeletePublicIntegrationFunction, GetFunctionDeployment, GetFunctionDryrun, GetIntegrationFunction, GetIntegrationFunctions, GetIntegrationTemplates, GetProviderTemplates, GetPublicIntegrationFunction, GetPublicIntegrationFunctions, GetPublicProviderTemplates, PostFunctionCompile, PostFunctionDeployment, PostFunctionDeploymentResult, PostFunctionDryrun, PostFunctionDryrunResult } from './functions/api.js';
 import type { GetGettingStarted, PatchGettingStarted } from './gettingStarted/api.js';
-import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicFunctionCode, GetPublicIntegration, GetPublicListIntegrations, PatchIntegration, PatchPublicIntegration, PostIntegration, PostPublicIntegration, PostPublicQuickstartIntegration } from './integration/api.js';
+import type { DeleteIntegration, DeletePublicIntegration, GetFunctionCode, GetIntegration, GetIntegrationFlows, GetPublicFunctionCode, GetPublicIntegration, GetPublicListIntegrations, PatchIntegration, PatchPublicIntegration, PostIntegration, PostPublicIntegration, PostPublicQuickstartIntegration } from './integration/api.js';
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api.js';
 import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api.js';
 import type { GetMeta } from './meta/api.js';
@@ -29,8 +31,8 @@ import type { GetPublicSyncStatus, PostPublicSyncPause, PostPublicSyncStart, Pos
 import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api.js';
 import type { GetUser, PatchUser, PutUserPassword } from './user/api.js';
 import type { PostPublicWebhook } from './webhooks/http.api.js';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | DeletePublicIntegrationFunction | GetPublicProviderTemplates | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetConnectionRecordModels | GetConnectionRecords | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction | GetPlainHmac;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicClientMetadata | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PostCliTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | DeletePublicIntegrationFunction | GetPublicProviderTemplates | AllPublicProxy;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | GetFunctionCode | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetConnectionRecordModels | GetConnectionRecords | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PatchConnection | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction | GetPlainHmac;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/billing/types.d.ts

@@ -80,6 +80,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';
 }
 export type DimensionFor<M extends UsageMetric> = 'none' | BreakdownDimensions[M];
 export interface GetBillingUsageOpts {
@@ -93,10 +94,9 @@ export interface GetBillingUsageOpts {
         group_by?: 'environmentId' | 'environmentName' | 'integrationId' | 'type' | 'functionName' | 'model';
     };
     /**
-     * Per-request override of the dashboard backend source. Honoured only
-     * when `FLAG_ALLOW_OVERRIDE_GETUSAGE_SERVICE` is enabled (dev gate); ignored
-     * everywhere else, so the default stays Orb. Only used by
-     * `UsageTracker.getBillingUsage`; the Orb client itself ignores it.
+     * 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';
     /**
@@ -120,9 +120,11 @@ export interface GetBillingUsageOpts {
     metrics?: UsageMetric[];
     /**
      * Per-metric row-level filter: scopes that metric's response to rows
-     * where the given dimension equals the given value. Mutually exclusive
-     * with `breakdown[<metric>]` on the same metric — controllers reject
-     * the combination. CH path only; the Orb client ignores it.
+     * 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.
      */
     filter?: {
         [M in UsageMetric]?: {
@@ -159,11 +161,11 @@ export interface BillingUsageMetric {
      * dimension-value series (carrying its own `group: {key, value}`), with
      * one 'rest' entry aggregating the long tail.
      *
-     * Mutually exclusive with the top-level `usage`/`total`: when breakdown
-     * is requested the top-level is empty (`usage: []`, `total: 0`) and only
-     * `breakdown` carries data — callers asking for a breakdown opt into the
-     * per-dim view. When breakdown is NOT requested, the top-level is the
-     * no-dim global and this field is absent.
+     * Paired with the top-level `usage`/`total`: when a breakdown is requested
+     * the top-level `usage` is empty (the per-day points live under `breakdown`)
+     * and `total` is the sum across the top-N + 'rest' series, which partition
+     * every row — so it equals the (filtered) global. When breakdown is NOT
+     * requested, the top-level is the no-dim global and this is absent.
      */
     breakdown?: BillingUsageMetric[];
 }

package/dist/cli/api.d.ts

@@ -0,0 +1,12 @@
+import type { Endpoint } 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<{
+    Method: 'POST';
+    Path: '/cli/telemetry';
+    Body: {
+        deviceId: string;
+        event: CliTelemetryEvent;
+        ephemeral?: boolean;
+    };
+    Success: never;
+}>;

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

@@ -0,0 +1,20 @@
+import type { ApiError, Endpoint } from '../api.js';
+export type GetPublicClientMetadata = Endpoint<{
+    Method: 'GET';
+    Path: '/oauth/client-metadata/:environmentUuid/:providerConfigKey';
+    Params: {
+        environmentUuid: string;
+        providerConfigKey: string;
+    };
+    Error: ApiError<'unknown_environment'> | ApiError<'unknown_provider_config'>;
+    Success: {
+        client_id: string;
+        client_name: string;
+        client_uri: string;
+        logo_uri?: string;
+        redirect_uris: string[];
+        grant_types: string[];
+        response_types: string[];
+        token_endpoint_auth_method: 'none';
+    };
+}>;

package/dist/connect/api.d.ts

@@ -9,6 +9,7 @@ export interface ConnectSessionInput {
         connection_config?: {
             [key: string]: unknown;
             oauth_scopes_override?: string | undefined;
+            webhook_url?: string | undefined;
         } | undefined;
     }> | undefined;
     end_user: EndUserInput;

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

@@ -7,7 +7,7 @@ import type { ActiveLog } from '../../notification/active-logs/db.js';
 import type { ReplaceInObject } from '../../utils.js';
 import type { ConnectionConfig, DBConnection, DBConnectionDecrypted } from '../db.js';
 import type { Merge } from 'type-fest';
-export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id' | 'connection_id' | 'provider_config_key' | 'created_at' | 'updated_at'> & {
+export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id' | 'config_id' | 'connection_id' | 'provider_config_key' | 'created_at' | 'updated_at'> & {
     provider: string;
     errors: {
         type: string;
@@ -163,11 +163,32 @@ export type PatchPublicConnection = Endpoint<{
     Body: {
         end_user?: EndUserInput | undefined;
         tags?: Tags | undefined;
+        webhook_url?: string | undefined;
     };
     Success: {
         success: boolean;
     };
-    Error: ApiError<'unknown_provider_config'>;
+    Error: ApiError<'unknown_provider_config' | 'not_found' | 'server_error' | 'invalid_body'>;
+}>;
+export type PatchConnection = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/connections/:connectionId';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        provider_config_key: string;
+        env: string;
+    };
+    Body: {
+        end_user?: EndUserInput | undefined;
+        tags?: Tags | undefined;
+        webhook_url?: string | undefined;
+    };
+    Success: {
+        success: boolean;
+    };
+    Error: ApiError<'unknown_provider_config' | 'not_found' | 'server_error' | 'invalid_body'>;
 }>;
 export type PostConnectionRefresh = Endpoint<{
     Method: 'POST';

package/dist/connection/db.d.ts

@@ -11,6 +11,7 @@ export interface ConnectionConfig {
     oauth_scopes_override?: string[] | undefined;
     oauth_scopes?: string | undefined;
     authorization_params?: Record<string, string> | undefined;
+    webhook_url?: string | undefined;
 }
 export interface DBConnection extends TimestampsAndDeletedCorrect {
     id: number;
@@ -55,7 +56,7 @@ export interface FailedConnectionError {
     description: string;
 }
 export interface RecentlyFailedConnection {
-    connection: DBConnection | Pick<DBConnection, 'connection_id' | 'provider_config_key'>;
+    connection: DBConnection | Pick<DBConnection, 'connection_id' | 'provider_config_key' | 'connection_config'>;
     auth_mode: AuthModeType;
     error?: FailedConnectionError;
     operation: AuthOperationType;

package/dist/deploy/api.d.ts

@@ -1,8 +1,8 @@
 import type { ApiError, Endpoint } from '../api.js';
-import type { CLIDeployFlowConfig, OnEventScriptsByProvider } from './incomingFlow.js';
-import type { SyncDeploymentResult } from './index.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<{
     Method: 'POST';

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

@@ -27,7 +27,6 @@ export type PostPreBuiltDeploy = Endpoint<{
         env: string;
     };
     Body: {
-        provider: string;
         providerConfigKey: string;
         scriptName: string;
         type: ScriptTypeLiteral;

package/dist/functions/api.d.ts

@@ -68,7 +68,7 @@ export type FunctionDryrunResultBody = {
         payload?: unknown;
     };
 };
-export interface FunctionDeploymentBody {
+export interface FunctionDeploymentCodeBody {
     type: 'function';
     integration_id: string;
     function_name: string;
@@ -77,9 +77,24 @@ export interface FunctionDeploymentBody {
     version?: string | undefined;
     allow_destructive?: boolean | undefined;
 }
+export interface FunctionDeploymentTemplateBody {
+    type: 'template';
+    integration_id: string;
+    template: string;
+    /** Optional; inferred from the template name unless a sync and an action share it. */
+    function_type?: RunnableFunctionType | undefined;
+}
+export interface FunctionDeploymentTemplateStoredRequest {
+    type: 'template';
+    integration_id: string;
+    template: string;
+    function_name: string;
+    function_type: RunnableFunctionType;
+}
+export type FunctionDeploymentBody = FunctionDeploymentCodeBody | FunctionDeploymentTemplateBody;
 export interface FunctionDeploymentCreateSuccess {
     id: string;
-    status: Extract<FunctionDeploymentStatus, 'waiting' | 'running'>;
+    status: FunctionDeploymentStatus;
     created_at: string;
 }
 export interface FunctionDeploymentResultSuccess {
@@ -154,7 +169,7 @@ export type PostFunctionDeployment = Endpoint<{
     Method: 'POST';
     Path: '/functions/deployments';
     Body: FunctionDeploymentBody;
-    Error: ApiError<FunctionErrorCode>;
+    Error: ApiError<FunctionErrorCode> | ApiError<'template_not_found' | 'ambiguous_function' | 'plan_limit' | 'template_already_deployed'>;
     Success: FunctionDeploymentCreateSuccess;
 }>;
 export type GetFunctionDeployment = Endpoint<{

package/dist/functions/capabilities.d.ts

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

package/dist/gettingStarted/api.d.ts

@@ -1,5 +1,5 @@
-import type { GettingStartedOutput as GettingStartedProgressOutput, PatchGettingStartedInput as PatchGettingStartedProgressInput } from './dto.js';
 import type { ApiError, Endpoint } from '../api.js';
+import type { GettingStartedOutput as GettingStartedProgressOutput, PatchGettingStartedInput as PatchGettingStartedProgressInput } from './dto.js';
 export type GetGettingStarted = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/getting-started';

package/dist/gettingStarted/dto.d.ts

@@ -1,7 +1,7 @@
-import type { DBGettingStartedMeta, DBGettingStartedProgress } from './db.js';
 import type { DBConnection } from '../connection/db.js';
 import type { DBEnvironment } from '../environment/db.js';
 import type { IntegrationConfig } from '../integration/db.js';
+import type { DBGettingStartedMeta, DBGettingStartedProgress } from './db.js';
 export interface GettingStartedOutput {
     meta: {
         environment: Pick<DBEnvironment, 'id' | 'name'>;

package/dist/index.d.ts

@@ -55,6 +55,7 @@ export type * from './deploy/api.js';
 export type * from './deploy/index.js';
 export type * from './deploy/incomingFlow.js';
 export type * from './endpoints/db.js';
+export type * from './cli/api.js';
 export type * from './connect/api.js';
 export type * from './connect/session.js';
 export type * from './endUser/index.js';
@@ -77,6 +78,7 @@ export type * from './environment/variable/api.js';
 export type * from './webhooks/api.js';
 export type * from './webhooks/dispatch.js';
 export type * from './webhooks/http.api.js';
+export type * from './clientMetadata/http.api.js';
 export type * from './flow/http.api.js';
 export type * from './flow/index.js';
 export type * from './utils.js';
@@ -89,6 +91,7 @@ export type * from './checkpoint/types.js';
 export type * from './checkpoint/db.js';
 export type * from './mcp/api.js';
 export type * from './functions/api.js';
+export type * from './functions/capabilities.js';
 export type * from './functions/domain.js';
 export type * from './lambda/index.js';
 export type * from './authz/types.js';

package/dist/integration/api.d.ts

@@ -1,9 +1,9 @@
 import type { ApiError, ApiTimestamps, Endpoint } from '../api.js';
-import type { IntegrationConfig } from './db.js';
-import type { AuthModeType, AuthModes } from '../auth/api.js';
+import type { AuthModes, AuthModeType } from '../auth/api.js';
 import type { NangoSyncConfig } from '../flow/index.js';
 import type { ScriptTypeLiteral } from '../nangoYaml/index.js';
 import type { Provider } from '../providers/provider.js';
+import type { IntegrationConfig } from './db.js';
 import type { Merge } from 'type-fest';
 export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider' | 'display_name' | 'forward_webhooks'>, ApiTimestamps> & {
     logo: string;
@@ -131,6 +131,28 @@ export type GetPublicFunctionCode = Endpoint<{
         }[];
     }>;
 }>;
+export type GetFunctionCode = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/integrations/:providerConfigKey/functions/:functionName/code';
+    Params: {
+        providerConfigKey: string;
+        functionName: string;
+    };
+    Querystring: {
+        env: string;
+        type?: ScriptTypeLiteral | undefined;
+    };
+    Success: {
+        type: ScriptTypeLiteral;
+        code: string;
+    };
+    Error: ApiError<'not_found'> | ApiError<'ambiguous_function', undefined, {
+        matches: {
+            type: ScriptTypeLiteral;
+            name: string;
+        }[];
+    }>;
+}>;
 export type ApiIntegration = Omit<Merge<IntegrationConfig, ApiTimestamps>, 'oauth_client_secret_iv' | 'oauth_client_secret_tag'>;
 export type ApiIntegrationList = ApiIntegration & {
     meta: {
@@ -231,6 +253,7 @@ export type GetIntegration = Endpoint<{
         data: {
             integration: ApiIntegration;
             template: Provider;
+            symLinkTargetName: string | null;
             meta: {
                 connectionsCount: number;
                 webhookUrl: string | null;

package/dist/mcp/api.d.ts

@@ -1,5 +1,5 @@
 import type { ApiError, Endpoint } from '../api.js';
-export type PostMcp = Endpoint<{
+export type PostConnectionToolsMcp = Endpoint<{
     Method: 'POST';
     Path: '/mcp';
     Body: Record<string, unknown>;
@@ -10,7 +10,18 @@ export type PostMcp = Endpoint<{
     Success: Record<string, unknown>;
     Error: ApiError<'missing_connection_id' | 'unknown_connection'>;
 }>;
-export type GetMcp = Endpoint<{
+export type GetConnectionToolsMcp = Endpoint<{
+    Method: 'GET';
+    Path: '/mcp';
+    Success: Record<string, unknown>;
+}>;
+export type PostControlPlaneMcp = Endpoint<{
+    Method: 'POST';
+    Path: '/mcp';
+    Body: Record<string, unknown>;
+    Success: Record<string, unknown>;
+}>;
+export type GetControlPlaneMcp = Endpoint<{
     Method: 'GET';
     Path: '/mcp';
     Success: Record<string, unknown>;

package/dist/nangoYaml/index.d.ts

@@ -6,11 +6,6 @@ export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export type SyncTypeLiteral = 'incremental' | 'full';
 export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'functions' | 'webhooks' | 'post-connection-scripts';
 export type ScriptTypeLiteral = 'action' | 'sync' | 'on-event';
-/**
- * The `function` primitive is authored via `createFunction()` / `createWebhook()`. It is tracked
- * separately from {@link ScriptTypeLiteral} (sync/action/on-event) while it is introduced additively.
- */
-export type FunctionScriptTypeLiteral = 'function';
 export interface NangoYamlV1 {
     integrations: Record<string, Record<string, NangoYamlV1Integration>>;
     models: NangoYamlModel;
@@ -81,7 +76,6 @@ export interface NangoYamlParsedIntegration {
     providerConfigKey: string;
     syncs: ParsedNangoSync[];
     actions: ParsedNangoAction[];
-    functions: ParsedNangoFunction[];
     onEventScripts: Record<OnEventType, string[]>;
     /**
      * @deprecated
@@ -107,47 +101,6 @@ export interface ParsedNangoSync {
     json_schema?: JSONSchema7 | undefined;
     features?: Feature[] | undefined;
 }
-/** Serializable view of a function trigger (the executable hooks live in the deployed file body). */
-export interface ParsedFunctionTrigger {
-    type: 'http' | 'schedule' | 'event';
-    /** http trigger: maps to the URL path segment. */
-    name?: string;
-    /** http trigger: 'integration' (default) or 'connection' for tokenized per-connection URLs. */
-    scope?: 'integration' | 'connection';
-    /** schedule trigger. */
-    schedule?: string;
-    /** event trigger. */
-    event?: string;
-    /** Whether ingress coalescing is configured (the window/key config). */
-    debounce?: {
-        key?: {
-            body: string;
-        } | {
-            header: string;
-        };
-        windowMs: number;
-        maxWindowMs?: number;
-        maxEntities?: number;
-        payloadMode?: 'latest' | 'all';
-    };
-    /** Whether the trigger ships an `ingressChallenge` hook (executed at ingress). */
-    hasIngressChallenge?: boolean;
-    /** Whether the trigger ships an `ingressValidation` hook (executed at ingress). */
-    hasIngressValidation?: boolean;
-}
-export interface ParsedNangoFunction {
-    name: string;
-    type: 'function';
-    description: string;
-    triggers: ParsedFunctionTrigger[];
-    input: string | null;
-    output: string[] | null;
-    scopes: string[];
-    usedModels: string[];
-    version: string;
-    json_schema?: JSONSchema7 | undefined;
-    features?: Feature[] | undefined;
-}
 export interface ParsedNangoAction {
     name: string;
     type: 'action';
@@ -193,5 +146,6 @@ export interface FlowsYaml {
 export type FlowZeroJson = Omit<NangoYamlParsedIntegration, 'functions'> & {
     jsonSchema?: JSONSchema7;
     sdkVersion: string;
+    symLinkTargetName?: string;
 };
 export type FlowsZeroJson = FlowZeroJson[];

package/dist/persist/api.d.ts

@@ -73,4 +73,116 @@ export interface PutCheckpointSuccess {
     checkpoint: Checkpoint;
     version: number;
 }
+export interface GetTaskAbortSuccess {
+    aborted: boolean;
+}
+export type PutTaskAbort = Endpoint<{
+    Method: 'PUT';
+    Path: '/environment/:environmentId/runner/task/:taskId/abort';
+    Params: {
+        environmentId: number;
+        taskId: string;
+    };
+    Error: ApiError<'put_task_abort_failed'>;
+    Success: never;
+}>;
+export type GetTaskAbort = Endpoint<{
+    Method: 'GET';
+    Path: '/environment/:environmentId/runner/task/:taskId/abort';
+    Params: {
+        environmentId: number;
+        taskId: string;
+    };
+    Error: ApiError<'get_task_abort_failed'>;
+    Success: GetTaskAbortSuccess;
+}>;
+export type PutSyncConflict = Endpoint<{
+    Method: 'PUT';
+    Path: '/environment/:environmentId/runner/sync-conflict';
+    Params: {
+        environmentId: number;
+    };
+    Body: {
+        scriptType: 'sync';
+        syncId: string;
+        refresh?: boolean;
+        ttlMs: number;
+    };
+    Error: ApiError<'sync_conflict' | 'put_sync_conflict_failed'>;
+    Success: never;
+}>;
+export type DeleteSyncConflict = Endpoint<{
+    Method: 'DELETE';
+    Path: '/environment/:environmentId/runner/sync-conflict';
+    Params: {
+        environmentId: number;
+    };
+    Body: {
+        scriptType: 'sync';
+        syncId: string;
+    };
+    Error: ApiError<'delete_sync_conflict_failed'>;
+    Success: never;
+}>;
+export interface TryAcquireLockSuccess {
+    acquired: boolean;
+}
+export type PostRunnerLockTryAcquire = Endpoint<{
+    Method: 'POST';
+    Path: '/environment/:environmentId/runner/locks/try-acquire';
+    Params: {
+        environmentId: number;
+    };
+    Body: {
+        owner: string;
+        key: string;
+        ttlMs: number;
+    };
+    Error: ApiError<'try_acquire_lock_failed'>;
+    Success: TryAcquireLockSuccess;
+}>;
+export interface ReleaseLockSuccess {
+    released: boolean;
+}
+export type PostRunnerLockRelease = Endpoint<{
+    Method: 'POST';
+    Path: '/environment/:environmentId/runner/locks/release';
+    Params: {
+        environmentId: number;
+    };
+    Body: {
+        owner: string;
+        key: string;
+    };
+    Error: ApiError<'release_lock_failed'>;
+    Success: ReleaseLockSuccess;
+}>;
+export type PostRunnerLockReleaseAll = Endpoint<{
+    Method: 'POST';
+    Path: '/environment/:environmentId/runner/locks/release-all';
+    Params: {
+        environmentId: number;
+    };
+    Body: {
+        owner: string;
+    };
+    Error: ApiError<'release_all_locks_failed'>;
+    Success: never;
+}>;
+export interface HasLockSuccess {
+    hasLock: boolean;
+}
+export type GetRunnerLock = Endpoint<{
+    Method: 'GET';
+    Path: '/environment/:environmentId/runner/locks';
+    Params: {
+        environmentId: number;
+    };
+    Querystring: {
+        owner: string;
+        key: string;
+    };
+    Error: ApiError<'has_lock_failed'>;
+    Success: HasLockSuccess;
+}>;
 export {};

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' | 'starter-v2' | 'growth-v2' | 'enterprise' | 'starter' | 'growth' | 'starter-legacy' | 'scale-legacy' | 'growth-legacy';
+    name: 'free' | 'free-uncapped' | 'startup-deal' | '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;
@@ -89,7 +89,7 @@ export interface DBPlan extends Timestamps {
      * Change the applied rate limit for the public API
      * @default "m"
      */
-    api_rate_limit_size: 's' | 'm' | 'l' | 'xl' | '2xl' | '3xl' | '4xl';
+    api_rate_limit_size: 's' | 'm' | 'l' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl';
     /**
      * Enable or disable machine auto idling
      * @default true

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

@@ -1,8 +1,8 @@
-import type { DBPlan } from './db.js';
 import type { Endpoint } from '../api.js';
 import type { ApiBillingUsageMetrics, BillingCustomer, BillingInvoicingDetails, BreakdownDimensions } from '../billing/types.js';
 import type { MetricUsageSummary, UsageMetric } from '../usage/index.js';
 import type { ReplaceInObject } from '../utils.js';
+import type { DBPlan } from './db.js';
 export type ApiPlan = ReplaceInObject<DBPlan, Date, string>;
 export type PostPlanExtendTrial = Endpoint<{
     Method: 'POST';
@@ -71,7 +71,8 @@ export type GetBillingUsageTopDimensionValues = Endpoint<{
             dimension: BreakdownDimensions[M];
             from: string;
             to: string;
-            limit?: string | undefined;
+            search?: string | undefined;
+            page?: string | undefined;
         };
     }[UsageMetric];
     Success: {
@@ -80,6 +81,11 @@ export type GetBillingUsageTopDimensionValues = Endpoint<{
                 id: string;
                 label: string;
             }[];
+            pagination: {
+                page: number;
+                limit: number;
+                hasMore: boolean;
+            };
         };
     };
 }>;

package/dist/providers/api.d.ts

@@ -1,6 +1,6 @@
 import type { Endpoint } from '../api.js';
-import type { Provider, SimplifiedJSONSchema } from './provider.js';
 import type { AuthModeType } from '../auth/api.js';
+import type { McpOAuth2ClientRegistration, Provider, SimplifiedJSONSchema } from './provider.js';
 export type GetPublicProviders = Endpoint<{
     Method: 'GET';
     Path: `/providers`;
@@ -40,7 +40,7 @@ export interface ApiProviderListItem {
     docs_connect?: string | undefined;
     preConfigured: boolean;
     preConfiguredScopes: string[];
-    clientRegistration?: 'dynamic' | 'static' | 'metadata';
+    clientRegistration?: McpOAuth2ClientRegistration;
     integration_config?: Record<string, SimplifiedJSONSchema> | undefined;
 }
 export type GetProviders = Endpoint<{

package/dist/providers/provider.d.ts

@@ -129,7 +129,7 @@ export interface ProviderCustom extends Omit<ProviderOAuth2, 'auth_mode'> {
         APP: string;
     };
 }
-export type McpOAuth2ClientRegistration = 'dynamic' | 'static' | 'metadata';
+export type McpOAuth2ClientRegistration = 'dynamic' | 'static' | 'cimd';
 export interface ProviderMcpOAUTH2 extends Omit<BaseProvider, 'body_format'> {
     auth_mode: 'MCP_OAUTH2';
     registration_url?: string;

package/dist/pubsub/events.d.ts

@@ -95,7 +95,7 @@ export type UsageWebhookForwardEvent = UsageEventBase<'usage.webhook_forward', {
         success: boolean;
     };
 }>;
-export type DataTransferCallsite = 'credential_test_hook' | 'credential_verification_hook' | 'connection_hook' | 'webhook_forward' | 'proxy' | 'uncontrolled_fetch' | 'persist_logs' | 'persist_records';
+export type DataTransferCallsite = 'credential_test_hook' | 'credential_verification_hook' | 'connection_hook' | 'webhook_forward' | 'proxy' | 'uncontrolled_fetch' | 'persist_logs' | 'persist_records' | 'get_/records' | 'get_/proxy' | 'patch_/proxy' | 'post_/proxy' | 'put_/proxy' | 'delete_/proxy' | 'unknown_/proxy';
 export type UsageDataTransferEvent = UsageEventBase<'usage.data_transfer', {
     value: number;
     properties: {

package/dist/runner/index.d.ts

@@ -1,7 +1,7 @@
-import type { TelemetryBag } from './sdk.js';
 import type { CheckpointRange } from '../checkpoint/types.js';
 import type { DBPlan } from '../plans/db.js';
 import type { Feature } from '../syncConfigs/db.js';
+import type { TelemetryBag } from './sdk.js';
 export interface RunnerOutputError {
     type: string;
     payload: Record<string, unknown> | unknown[];

package/dist/runner/sdk.d.ts

@@ -1,13 +1,13 @@
-import type { RunnerFlags } from './index.js';
 import type { LogLevel } from '../logs/messages.js';
 import type { IntegrationConfigForProxy } from '../proxy/api.js';
 import type { DBSyncConfig } from '../syncConfigs/db.js';
 import type { DBTeam } from '../team/db.js';
+import type { RunnerFlags } from './index.js';
 import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse } from 'axios';
 export interface SdkLogger {
     level: LogLevel | 'off';
 }
-export type ConflictResolutionMode = 'IN_MEMORY' | 'REDIS';
+export type ConflictResolutionMode = 'IN_MEMORY' | 'DISTRIBUTED';
 export type ScriptType = 'sync' | 'action' | 'webhook' | 'on-event';
 export interface NangoProps {
     scriptType: ScriptType;

package/dist/sync/api.d.ts

@@ -1,5 +1,5 @@
-import type { ReportedSyncJobStatus } from './index.js';
 import type { ApiError, Endpoint } from '../api.js';
+import type { ReportedSyncJobStatus } from './index.js';
 export type PostPublicTrigger = Endpoint<{
     Method: 'POST';
     Path: '/sync/trigger';

package/dist/team/api.d.ts

@@ -1,8 +1,8 @@
 import type { ApiError, ApiTimestamps, Endpoint } from '../api.js';
-import type { DBTeam } from './db.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<{
     Method: 'GET';

package/dist/usage/index.d.ts

@@ -1,4 +1,4 @@
-export type UsageMetric = 'proxy' | 'connections' | 'function_executions' | 'function_compute_gbms' | 'records' | 'webhook_forwards' | 'function_logs';
+export type UsageMetric = 'proxy' | 'connections' | 'function_executions' | 'function_compute_gbms' | 'records' | 'webhook_forwards' | 'function_logs' | 'data_transfer';
 export interface MetricUsageSummary {
     label: string;
     usage: number;

package/package.json

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