@nangohq/types 0.71.13 → 0.72.0

package/dist/analytics/catalogue.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/analytics/taxonomy.d.ts

@@ -0,0 +1,72 @@
+export type AnalyticsSurface = 'web' | 'cli' | 'server';
+export interface AnalyticsCategories {
+    auth: 'Signing up, logging in and account access';
+    audit: "The account's audit trail: who did what in the account. Not function logs";
+    onboarding: 'Getting Started';
+    connections: 'Creating and managing connections';
+    playground: 'The dashboard Playground';
+    functions: 'Writing, deploying and running syncs and actions, including from the CLI';
+    billing: 'Plans, usage and payment';
+    agents: 'Agent sessions and the tools agents call through them';
+    integrations: 'Creating and configuring integrations';
+    environments: 'Environments and their settings';
+    team: 'The people in an account and their roles';
+    logs: 'Searching and reading operation logs';
+}
+export interface AnalyticsObjects {
+    account: 'A Nango account';
+    user: 'A person in an account';
+    connection: "An end user's authorised link to an integration";
+    integration: 'A provider configured in an environment. Never `provider`';
+    deploy: 'Pushing functions to an environment';
+    command: 'A CLI command, such as `compile` or `deploy`';
+    function: 'A sync or an action';
+    run: 'One execution of a function';
+    api_key: 'An account or environment key';
+    environment: 'Dev, prod or a custom environment';
+    plan: "The account's pricing plan";
+    session: 'An agent session';
+    tool_call: 'One call an agent makes to a tool in its session';
+    proxy_request: "One request an agent sends to an integration's API through the proxy";
+    tool_search: 'One search an agent runs for tools in its session';
+    usage: "The Usage page's metrics and charts";
+    playground: 'The dashboard Playground panel';
+    agent_turn: 'One message and its reply in an Agent Playground chat';
+    approval: 'A tool call in an Agent Playground chat that waits for the user to approve or deny it';
+    two_factor: "A user's two-factor authentication";
+    recovery_codes: "A user's two-factor recovery codes";
+    password: "A user's password";
+    join_request: 'A request to join an existing account';
+    export: 'A file of records produced for download, such as the audit trail';
+    sync_command: "A run, full resync, pause, resume or cancel sent to a connection's sync";
+    operation: 'One entry in the logs, such as a sync run or an auth attempt';
+    filter: 'A search or filter on a dashboard list';
+}
+export interface AnalyticsUiElements {
+    button: 'A dashboard button, such as `create_button`';
+    link: 'A dashboard link, such as `invoice_link`';
+    tab: 'A dashboard tab';
+    modal: 'A dashboard modal';
+    page: 'A dashboard page, such as `create_page`';
+}
+export interface AnalyticsActions {
+    click: 'A UI element was clicked';
+    submit: 'A form or request was sent';
+    create: 'A new thing was created, or a creation attempt finished. Include `is_success` when failures are tracked';
+    view: 'A page or item was seen';
+    add: 'Something was added to an existing thing';
+    invite: 'Someone was invited';
+    update: 'Something changed';
+    delete: 'Something was destroyed';
+    remove: 'Something was taken out of an existing thing, not destroyed';
+    start: 'Something with a lifetime began, such as a session. Pairs with `end`';
+    end: 'Something with a lifetime stopped. Pairs with `start`';
+    complete: 'An operation that produces no new thing finished, such as a run or a tool call. Always carries `is_success`';
+    cancel: 'Someone stopped a process';
+    generate: 'Something was produced automatically';
+    send: 'Something was sent to someone';
+}
+export type AnalyticsCategory = keyof AnalyticsCategories;
+export type AnalyticsObject = keyof AnalyticsObjects | `${string}_${keyof AnalyticsUiElements}`;
+export type AnalyticsAction = keyof AnalyticsActions;
+export type AnalyticsEventName = `${AnalyticsCategory}:${AnalyticsObject}_${AnalyticsAction}`;

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

@@ -1,10 +1,10 @@
 /** Every wildcard in a namespace: `environment:*`, `environment:connections:*`, … */
 export type WildcardsFor<Namespace extends string> = `${Namespace}:*` | `${Namespace}:${string}:*`;
-export declare const API_KEY_SCOPES: readonly ["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:connections:list", "environment:connections:list_credentials", "environment:connections:read", "environment:connections:read_credentials", "environment:connections:create", "environment:connections:update", "environment:connections:delete", "environment:connect_sessions:write", "environment:agent_sessions:write", "environment:syncs:read", "environment:syncs:execute", "environment:syncs:update", "environment:syncs:variant:create", "environment:syncs:variant:delete", "environment:functions:list", "environment:functions:read", "environment:functions:update", "environment:functions:delete", "environment:functions:compile", "environment:functions:dryrun", "environment:functions:invocations", "environment:deploy", "environment:records:read", "environment:records:write", "environment:logs:read", "environment:actions:execute", "environment:proxy", "environment:variables:read", "environment:webhook_signing_key:rotate", "environment:mcp"];
+export declare const API_KEY_SCOPES: readonly ["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:connections:list", "environment:connections:list_credentials", "environment:connections:read", "environment:connections:read_credentials", "environment:connections:create", "environment:connections:update", "environment:connections:delete", "environment:connect_sessions:write", "environment:agent_sessions:write", "environment:syncs:read", "environment:syncs:execute", "environment:syncs:update", "environment:syncs:variant:create", "environment:syncs:variant:delete", "environment:functions:list", "environment:functions:read", "environment:functions:update", "environment:functions:delete", "environment:functions:compile", "environment:functions:dryrun", "environment:functions:invocations", "environment:deploy", "environment:records:read", "environment:records:write", "environment:logs:read", "environment:tools:call", "environment:proxy", "environment:variables:read", "environment:webhook_signing_key:rotate", "environment:mcp"];
 export type ConcreteApiKeyScope = (typeof API_KEY_SCOPES)[number];
 /** A scope, or a wildcard over scopes. Which wildcards resolve to something is checked at runtime. */
 export type ApiKeyScope = ConcreteApiKeyScope | WildcardsFor<'environment'>;
-export declare const ACCOUNT_API_KEY_SCOPES: readonly ["account:environments:list", "account:environments:create", "account:environments:delete", "account:environments:set_production", "account:environments:api_keys:list", "account:environments:api_keys:read", "account:environments:api_keys:create", "account:environments:api_keys:delete"];
+export declare const ACCOUNT_API_KEY_SCOPES: readonly ["account:environments:list", "account:environments:read", "account:environments:read_secret", "account:environments:create", "account:environments:delete", "account:environments:set_production", "account:environments:api_keys:list", "account:environments:api_keys:read", "account:environments:api_keys:create", "account:environments:api_keys:update", "account:environments:api_keys:delete"];
 export type ConcreteAccountApiKeyScope = (typeof ACCOUNT_API_KEY_SCOPES)[number];
 export type AccountApiKeyScope = ConcreteAccountApiKeyScope | WildcardsFor<'account'>;
 export type CustomerKeyScope = ApiKeyScope | AccountApiKeyScope;

package/dist/api.endpoints.d.ts

@@ -1,5 +1,5 @@
 import type { ConfirmEmail, CreateAccountApiKey, DeleteAccountApiKey, GetEmailByExpiredToken, GetEmailByUuid, GetManagedCallback, GetManagedEmailVerification, GetOnboardingAccountDiscovery, ListAccountApiKeys, PostForgotPassword, PostLogout, PostManagedEmailVerification, PostManagedSignup, PostOnboardingRequestInvite, PostSignin, PostSignup, PutResetPassword } from './account/api.js';
-import type { GetAsyncActionResult, GetPublicV1, PostInternalTriggerFunction, PostPublicTriggerAction } from './action/api.js';
+import type { GetAsyncActionResult, GetPublicV1, PostInternalInvokeFunction, PostPublicTriggerAction } from './action/api.js';
 import type { PostImpersonate } from './admin/http.api.js';
 import type { DeleteAgentSession, PostAgentSessions } from './agent/api.js';
 import type { GetAgentSessionMcp, PostAgentSessionMcp } from './agent/mcp.api.js';
@@ -14,15 +14,16 @@ import type { DeleteConnection, DeletePublicConnection, GetConnection, GetConnec
 import type { PostConnectionMetadata, 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, DeletePublicApiKey, DeletePublicEnvironment, GetEnvironment, GetEnvironments, GetPublicApiKey, GetPublicApiKeys, GetPublicEnvironments, ListApiKeys, PatchApiKey, PatchEnvironment, PostEnvironment, PostPublicApiKey, PostPublicEnvironment, PostPublicRotateWebhookSigningKey, PostRotateWebhookSigningKey } from './environment/api/index.js';
+import type { CreateApiKey, DeleteApiKey, DeleteEnvironment, DeletePublicApiKey, DeletePublicEnvironment, GetEnvironment, GetEnvironments, GetPublicApiKey, GetPublicApiKeys, GetPublicEnvironment, GetPublicEnvironments, ListApiKeys, PatchApiKey, PatchEnvironment, PatchPublicApiKey, PostEnvironment, PostPublicApiKey, PostPublicEnvironment, PostPublicRotateWebhookSigningKey, PostRotateWebhookSigningKey } from './environment/api/index.js';
 import type { PatchWebhook } from './environment/api/webhook.js';
 import type { PostEnvironmentVariables } from './environment/variable/api.js';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api.js';
-import type { DeleteFunctionVariant, DeleteIntegrationFunction, DeletePublicIntegrationFunction, GetFunction, GetFunctionDeployment, GetFunctionDryrun, GetFunctionInvocation, GetFunctions, GetIntegrationFunction, GetIntegrationFunctions, GetIntegrationTemplates, GetProviderTemplates, GetPublicIntegrationFunction, GetPublicIntegrationFunctions, GetPublicProviderTemplates, PatchConnectionFunction, PatchFunction, PatchFunctionVariant, PostFunctionCompile, PostFunctionDeployment, PostFunctionDeploymentBundle, PostFunctionDeploymentBundlePreview, PostFunctionDeploymentResult, PostFunctionDryrun, PostFunctionDryrunResult, PostFunctionInvocation, PostFunctionVariant } from './functions/api.js';
+import type { DeleteFunctionVariant, DeleteIntegrationFunction, DeletePublicIntegrationFunction, GetFunction, GetFunctionDeployment, GetFunctionDryrun, GetFunctionInvocation, GetFunctions, GetIntegrationFunction, GetIntegrationFunctions, GetIntegrationTemplates, GetProviderTemplateCode, GetProviderTemplates, GetPublicIntegrationFunction, GetPublicIntegrationFunctions, GetPublicProviderTemplateCode, GetPublicProviderTemplates, PatchConnectionFunction, PatchFunction, PatchFunctionVariant, PostFunctionCompile, PostFunctionDeployment, PostFunctionDeploymentBundle, PostFunctionDeploymentBundlePreview, PostFunctionDeploymentResult, PostFunctionDryrun, PostFunctionDryrunResult, PostFunctionInvocation, PostFunctionVariant, PostToolCall } from './functions/api.js';
 import type { GetGettingStarted, PatchGettingStarted } from './gettingStarted/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 { GetConnectionToolsMcp, PostConnectionToolsMcp } from './mcp/api.js';
 import type { GetMeta } from './meta/api.js';
 import type { DeleteMFA, GetMFAStatus, PostMFAActivation, PostMFAEnrollment, PostMFALoginVerification, PostMFARecoveryCodes } from './mfa/api.js';
 import type { GetPlainHmac } from './plain/api.js';
@@ -36,8 +37,8 @@ import type { GetConnectionSyncs, GetPublicSyncStatus, PostPublicSyncPause, Post
 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 | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostAgentSessions | DeleteAgentSession | PostAgentSessionMcp | GetAgentSessionMcp | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | DeleteConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicClientMetadata | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PostCliTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | GetFunction | GetFunctions | PatchFunction | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | PostFunctionInvocation | PostFunctionVariant | PatchFunctionVariant | PatchConnectionFunction | DeleteFunctionVariant | GetFunctionInvocation | PostFunctionDeploymentBundle | PostFunctionDeploymentBundlePreview | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | DeletePublicIntegrationFunction | GetPublicProviderTemplates | PostPublicRotateWebhookSigningKey | AllPublicProxy | PostPublicEnvironment | DeletePublicEnvironment | GetPublicEnvironments | GetPublicApiKey | GetPublicApiKeys | PostPublicApiKey | DeletePublicApiKey;
-export type PrivateApiEndpoints = GetAuditTrail | GetAuditTrailExport | ListAccountApiKeys | CreateAccountApiKey | DeleteAccountApiKey | ConfirmEmail | PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetOverdueInvoices | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUpcomingInvoice | GetBillingPeriodCosts | GetProjectedCosts | GetSpendAlert | PutSpendAlert | DeleteSpendAlert | 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 | PatchConnection | PostConnectionMetadata | GetConnectionRecordModels | GetConnectionRecords | GetConnectionSyncs | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | GetOnboardingAccountDiscovery | PostOnboardingRequestInvite | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | PostRotateWebhookSigningKey | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction | GetMFAStatus | PostMFAEnrollment | PostMFAActivation | PostMFARecoveryCodes | PostMFALoginVerification | DeleteMFA | GetPlainHmac | PostAgentPlaygroundChat;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostAgentSessions | DeleteAgentSession | PostAgentSessionMcp | GetAgentSessionMcp | PostConnectionToolsMcp | GetConnectionToolsMcp | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | DeleteConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicClientMetadata | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PostCliTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | GetFunction | GetFunctions | PatchFunction | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | PostFunctionInvocation | PostFunctionVariant | PatchFunctionVariant | PatchConnectionFunction | DeleteFunctionVariant | GetFunctionInvocation | PostFunctionDeploymentBundle | PostFunctionDeploymentBundlePreview | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | PostToolCall | DeletePublicIntegrationFunction | GetPublicProviderTemplates | GetPublicProviderTemplateCode | PostPublicRotateWebhookSigningKey | AllPublicProxy | PostPublicEnvironment | DeletePublicEnvironment | GetPublicEnvironment | GetPublicEnvironments | GetPublicApiKey | GetPublicApiKeys | PostPublicApiKey | PatchPublicApiKey | DeletePublicApiKey;
+export type PrivateApiEndpoints = GetAuditTrail | GetAuditTrailExport | ListAccountApiKeys | CreateAccountApiKey | DeleteAccountApiKey | ConfirmEmail | PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetOverdueInvoices | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUpcomingInvoice | GetBillingPeriodCosts | GetProjectedCosts | GetSpendAlert | PutSpendAlert | DeleteSpendAlert | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | GetFunctionCode | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | GetProviderTemplateCode | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | PatchConnection | PostConnectionMetadata | GetConnectionRecordModels | GetConnectionRecords | GetConnectionSyncs | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | GetOnboardingAccountDiscovery | PostOnboardingRequestInvite | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | PostRotateWebhookSigningKey | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalInvokeFunction | GetMFAStatus | PostMFAEnrollment | PostMFAActivation | PostMFARecoveryCodes | PostMFALoginVerification | DeleteMFA | GetPlainHmac | PostAgentPlaygroundChat;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

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

@@ -34,6 +34,38 @@ export type GetPublicEnvironments = ApiEndpoint<{
         data: Pick<DBEnvironment, 'id' | 'uuid' | 'name' | 'is_production'>[];
     };
 }>;
+export type GetPublicEnvironment = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/environments/:environmentUuid';
+    Params: {
+        environmentUuid: string;
+    };
+    Querystring: {
+        with_secrets?: 'true' | 'false' | undefined;
+    };
+    Success: {
+        data: {
+            id: number;
+            uuid: string;
+            name: string;
+            is_production: boolean;
+            callback_url: string;
+            slack_notifications: boolean;
+            otlp_endpoint: string | null;
+            otlp_headers?: {
+                name: string;
+                value: string;
+            }[];
+            webhooks: ApiWebhooks & {
+                signing_key?: string;
+            };
+        };
+    };
+}>;
 export type PostEnvironment = ApiEndpoint<{
     Audit: AuditPolicy<'environment', 'created', 'account'>;
     Method: 'POST';
@@ -62,9 +94,35 @@ export type PostPublicEnvironment = ApiEndpoint<{
             name: string;
             value: string;
         }[] | undefined;
+        webhooks?: {
+            primary_url?: string | undefined;
+            secondary_url?: string | undefined;
+            on_sync_completion_always?: boolean | undefined;
+            on_auth_creation?: boolean | undefined;
+            on_auth_refresh_error?: boolean | undefined;
+            on_sync_error?: boolean | undefined;
+            on_async_action_completion?: boolean | undefined;
+            on_connection_deletion?: boolean | undefined;
+            signing_key?: string | undefined;
+        } | undefined;
     };
     Success: {
-        data: Pick<DBEnvironment, 'id' | 'uuid' | 'name'>;
+        data: {
+            id: number;
+            uuid: string;
+            name: string;
+            is_production: boolean;
+            callback_url: string;
+            slack_notifications: boolean;
+            otlp_endpoint: string | null;
+            otlp_headers: {
+                name: string;
+                value: string;
+            }[];
+            webhooks: ApiWebhooks & {
+                signing_key: string;
+            };
+        };
     };
     Error: ApiError<'conflict' | 'resource_capped' | 'invalid_is_prod_flag'>;
 }>;
@@ -211,6 +269,7 @@ export type PostPublicApiKey = ApiEndpoint<{
     };
     Body: {
         display_name: string;
+        scopes?: ApiKeyScope[];
     };
     Success: {
         data: {
@@ -271,6 +330,30 @@ export type GetPublicApiKey = ApiEndpoint<{
         };
     };
 }>;
+export type PatchPublicApiKey = ApiEndpoint<{
+    Audit: AuditPolicy<'api_key', 'updated', 'environment'>;
+    Method: 'PATCH';
+    Path: '/environments/:environmentUuid/api-keys/:keyUuid';
+    Params: {
+        environmentUuid: string;
+        keyUuid: string;
+    };
+    Body: {
+        display_name?: string;
+        scopes?: ApiKeyScope[];
+    };
+    Success: {
+        data: {
+            id: number;
+            uuid: string;
+            display_name: string;
+            scopes: ApiKeyScope[];
+            last_used_at: string | null;
+            created_at: string;
+        };
+    };
+    Error: ApiError<'conflict' | 'not_found'>;
+}>;
 export type DeletePublicApiKey = ApiEndpoint<{
     Audit: AuditPolicy<'api_key', 'deleted', 'environment'>;
     Method: 'DELETE';

package/dist/function/config.d.ts

@@ -1,5 +1,6 @@
 import type { OnEventType } from '../scripts/on-events/api.js';
-export type FunctionTags = Record<string, string | string[]>;
+export type FunctionTagValue = string | string[];
+export type FunctionTags = Record<string, FunctionTagValue>;
 export interface FunctionCapabilities {
     usesRecords: boolean;
     usesOutbound: boolean;

package/dist/function/db.d.ts

@@ -1,6 +1,7 @@
 import type { TimestampsAndDeletedAt } from '../db.js';
 import type { FunctionSource } from '../syncConfigs/db.js';
 import type { FunctionCapabilities, FunctionLimits, FunctionRequires, FunctionTags, FunctionTriggerDefinition } from './config.js';
+import type { ToolTags } from './tool.js';
 import type { JSONSchema7 } from 'json-schema';
 export interface DBFunctionConfig extends TimestampsAndDeletedAt {
     id: number;
@@ -15,7 +16,7 @@ export interface DBFunctionConfigVersion extends TimestampsAndDeletedAt {
     id: number;
     function_config_id: number;
     description: string;
-    tags: FunctionTags;
+    tags: FunctionTags | ToolTags;
     file_location: string;
     version: string;
     source: FunctionSource;

package/dist/function/tool.d.ts

@@ -0,0 +1,20 @@
+import type { FunctionTagValue } from './config.js';
+/** Explicit provider scope requirements; omit the declaration when requirements are unknown. */
+export type RequiredScopes = {
+    all: [string, ...string[]];
+    any?: never;
+    none?: never;
+} | {
+    any: [string, ...string[]];
+    all?: never;
+    none?: never;
+} | {
+    none: true;
+    all?: never;
+    any?: never;
+};
+export interface ToolTags {
+    instructions?: string;
+    required_scopes?: RequiredScopes;
+    [key: string]: FunctionTagValue | RequiredScopes;
+}

package/dist/functions/api.d.ts

@@ -1,8 +1,9 @@
 import type { ApiEndpoint, ApiError } from '../api.js';
 import type { AuditPolicy } from '../audit-trail/event.js';
 import type { FunctionCapabilities, FunctionLimits, FunctionRequires, FunctionTags, FunctionTriggerDefinition } from '../function/config.js';
+import type { ToolTags } from '../function/tool.js';
 import type { FunctionSource } from '../syncConfigs/db.js';
-import type { FunctionType, ListedNangoFunction, NangoActionFunction, NangoFunctionTemplate, NangoSyncFunction } from './domain.js';
+import type { FunctionListType, FunctionType, ListedNangoFunction, NangoActionFunction, NangoFunctionTemplate, NangoSyncFunction } from './domain.js';
 import type { JSONSchema7 } from 'json-schema';
 export type RunnableFunctionType = Extract<FunctionType, 'action' | 'sync'>;
 export type FunctionErrorCode = 'invalid_request' | 'server_error' | 'integration_not_found' | 'compilation_error' | 'dryrun_error' | 'deployment_error' | 'connection_not_found' | 'dryrun_not_found' | 'deployment_not_found' | 'function_disabled' | 'execution_environment_unavailable' | 'timeout' | 'validation_error';
@@ -229,10 +230,12 @@ export interface GetFunctionResponse {
     provider: string;
     name: string;
     description: string;
-    tags: FunctionTags;
+    tags: FunctionTags | ToolTags;
     state: 'enabled' | 'disabled';
     source: FunctionSource;
     trigger: FunctionTriggerDefinition;
+    input_json_schema: JSONSchema7 | null;
+    output_json_schema: JSONSchema7 | null;
     created_at: string;
     updated_at: string;
 }
@@ -299,7 +302,7 @@ export type PostFunctionInvocation = ApiEndpoint<{
         invocation_type: FunctionInvocationType;
         options?: Record<string, unknown> | undefined;
     };
-    Error: ApiError<FunctionInvocationErrorCode>;
+    Error: ApiError<FunctionInvocationErrorCode | 'function_runtime_error'>;
     Success: FunctionInvocationSuccess;
 }>;
 export type FunctionVariantErrorCode = 'invalid_variant' | 'function_not_found' | 'connection_not_found' | 'function_disabled' | 'function_variant_not_found' | 'invalid_frequency' | 'resource_capped' | 'server_error';
@@ -383,11 +386,11 @@ export type GetFunctionInvocation = ApiEndpoint<{
         functionUuid: string;
         id: string;
     };
-    Error: ApiError<'invalid_uri_params' | 'not_found' | 'function_not_found' | 'connection_not_found' | 'function_failed' | 'server_error'>;
+    Error: ApiError<'invalid_uri_params' | 'not_found' | 'function_not_found' | 'connection_not_found' | 'function_failed' | 'function_runtime_error' | 'server_error'>;
     Success: FunctionInvocationSuccess;
 }>;
 export interface FunctionListFilters {
-    type?: FunctionType;
+    type?: FunctionListType;
     search?: string;
     page?: number;
     limit?: number;
@@ -435,7 +438,7 @@ export type GetIntegrationFunction = ApiEndpoint<{
     Path: '/api/v1/integrations/:providerConfigKey/functions/:functionName';
     Querystring: {
         env: string;
-        type?: FunctionType;
+        type?: FunctionListType;
     };
     Params: {
         providerConfigKey: string;
@@ -495,7 +498,7 @@ export type GetPublicIntegrationFunction = ApiEndpoint<{
     Method: 'GET';
     Path: '/integrations/:uniqueKey/functions/:name';
     Querystring: {
-        type?: FunctionType;
+        type?: FunctionListType;
     };
     Params: {
         uniqueKey: string;
@@ -518,6 +521,26 @@ export type DeletePublicIntegrationFunction = ApiEndpoint<{
     Error: ApiError<'function_managed_by_deploy' | 'invalid_request'>;
     Success: FunctionDeletionSuccess;
 }>;
+export type PostToolCall = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'data-plane operation';
+    };
+    Method: 'POST';
+    Path: '/connections/:connectionId/tools/:name/calls';
+    Params: {
+        connectionId: string;
+        name: string;
+    };
+    Headers: {
+        'provider-config-key'?: string | undefined;
+    };
+    Body: {
+        input?: unknown | undefined;
+    };
+    Error: ApiError<FunctionInvocationErrorCode | 'function_runtime_error' | 'ambiguous_connection'>;
+    Success: FunctionInvocationSuccess;
+}>;
 export type GetPublicProviderTemplates = ApiEndpoint<{
     Audit: {
         kind: 'no-audit';
@@ -530,6 +553,53 @@ export type GetPublicProviderTemplates = ApiEndpoint<{
     };
     Success: ProviderTemplatesSuccess;
 }>;
+type ProviderTemplateCodeError = ApiError<'unknown_function'> | ApiError<'source_unavailable'> | ApiError<'ambiguous_function', undefined, {
+    matches: {
+        type: FunctionType;
+        name: string;
+    }[];
+}>;
+export type GetPublicProviderTemplateCode = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/providers/:provider/templates/:name/code';
+    Params: {
+        provider: string;
+        name: string;
+    };
+    Querystring: {
+        type?: FunctionType | undefined;
+    };
+    Success: {
+        type: FunctionType;
+        code: string;
+    };
+    Error: ProviderTemplateCodeError;
+}>;
+export type GetProviderTemplateCode = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/api/v1/providers/:providerConfigKey/templates/:name/code';
+    Params: {
+        providerConfigKey: string;
+        name: string;
+    };
+    Querystring: {
+        env: string;
+        type?: FunctionType | undefined;
+    };
+    Success: {
+        type: FunctionType;
+        code: string;
+    };
+    Error: ProviderTemplateCodeError;
+}>;
 export type GetIntegrationTemplates = ApiEndpoint<{
     Audit: {
         kind: 'no-audit';
@@ -551,7 +621,7 @@ export interface FunctionDeploymentArtifact {
     name: string;
     integrationId: string;
     description: string;
-    tags?: FunctionTags | undefined;
+    tags?: FunctionTags | ToolTags | undefined;
     trigger: FunctionTriggerDefinition;
     requires: FunctionRequires;
     capabilities: FunctionCapabilities;

package/dist/functions/domain.d.ts

@@ -1,9 +1,12 @@
+import type { FunctionTags } from '../function/config.js';
+import type { ToolTags } from '../function/tool.js';
 import type { OnEventType } from '../scripts/on-events/api.js';
 import type { FunctionSource } from '../syncConfigs/db.js';
 import type { JSONSchema7 } from 'json-schema';
 /** `tools-catalog` is list/API only — never a DB `FunctionSource`. */
 export type FunctionListSource = FunctionSource | 'tools-catalog';
 export type FunctionType = 'action' | 'sync' | 'on-event';
+export type FunctionListType = FunctionType | 'tool';
 interface NangoFunctionBase {
     name: string;
     description?: string;
@@ -40,7 +43,7 @@ export interface FunctionAvailability {
 }
 /** A row in a function list. Catalog actions have no deployed row. */
 export interface ListedFunctionAvailability {
-    /** Sync-config id. `null` when the function is served from the catalog (no deployed row). */
+    /** Sync-config id. `null` when the function is served from the catalog (no deployed row) or is a tool (identified by `uuid`). */
     id: number | null;
     enabled: boolean;
     /** ISO-8601 timestamp. `null` when the function was never deployed. */
@@ -50,7 +53,19 @@ export interface ListedFunctionAvailability {
 export type ListedNangoSyncFunction = NangoSyncFunction & ListedFunctionAvailability;
 export type ListedNangoActionFunction = NangoActionFunction & ListedFunctionAvailability;
 export type ListedNangoOnEventFunction = NangoOnEventFunction & ListedFunctionAvailability;
-export type ListedNangoFunction = ListedNangoSyncFunction | ListedNangoActionFunction | ListedNangoOnEventFunction;
+export type ListedNangoToolFunction = NangoFunctionBase & ListedFunctionAvailability & {
+    type: 'tool';
+    uuid: string;
+    integration_id: string;
+    provider: string;
+    description: string;
+    input_json_schema: JSONSchema7 | null;
+    output_json_schema: JSONSchema7 | null;
+    meta: Pick<ToolTags, 'instructions' | 'required_scopes'> & {
+        tags: FunctionTags;
+    };
+};
+export type ListedNangoFunction = ListedNangoSyncFunction | ListedNangoActionFunction | ListedNangoOnEventFunction | ListedNangoToolFunction;
 export type NangoFunctionTemplate = (NangoSyncFunction | NangoActionFunction) & {
     deployed?: FunctionAvailability;
 };

package/dist/index.d.ts

@@ -4,6 +4,8 @@ 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 './analytics/catalogue.js';
+export type * from './analytics/taxonomy.js';
 export type * from './gettingStarted/db.js';
 export type * from './gettingStarted/dto.js';
 export type * from './gettingStarted/api.js';
@@ -110,7 +112,10 @@ export type * from './mfa/db.js';
 export type * from './function/config.js';
 export type * from './function/db.js';
 export type * from './function/trigger.js';
+export type * from './function/tool.js';
 export type * from './functions/api.js';
 export type * from './functions/domain.js';
 export type * from './lambda/index.js';
 export type * from './pubsub/events.js';
+export type { SignupAdvertising } from './account/signupAdvertising.js';
+export type * from './self-hosting/db.js';

package/dist/integration/api.d.ts

@@ -2,11 +2,11 @@ import type { ApiEndpoint, ApiError, ApiTimestamps } from '../api.js';
 import type { AuditPolicy } from '../audit-trail/event.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 { FunctionListType } from '../functions/domain.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> & {
+export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider' | 'display_name' | 'forward_webhooks' | 'missing_fields'>, ApiTimestamps> & {
     logo: string;
 } & ApiPublicIntegrationInclude;
 export interface ApiPublicIntegrationInclude {
@@ -152,18 +152,13 @@ export type GetPublicFunctionCode = ApiEndpoint<{
         name: string;
     };
     Querystring: {
-        type?: ScriptTypeLiteral | undefined;
+        type?: FunctionListType | undefined;
     };
     Success: {
-        type: ScriptTypeLiteral;
+        type: FunctionListType;
         code: string;
     };
-    Error: ApiError<'not_found'> | ApiError<'ambiguous_function', undefined, {
-        matches: {
-            type: ScriptTypeLiteral;
-            name: string;
-        }[];
-    }>;
+    Error: ApiError<'not_found'>;
 }>;
 export type GetFunctionCode = ApiEndpoint<{
     Audit: {
@@ -178,18 +173,13 @@ export type GetFunctionCode = ApiEndpoint<{
     };
     Querystring: {
         env: string;
-        type?: ScriptTypeLiteral | undefined;
+        type?: FunctionListType | undefined;
     };
     Success: {
-        type: ScriptTypeLiteral;
+        type: FunctionListType;
         code: string;
     };
-    Error: ApiError<'not_found'> | ApiError<'ambiguous_function', undefined, {
-        matches: {
-            type: ScriptTypeLiteral;
-            name: string;
-        }[];
-    }>;
+    Error: ApiError<'not_found'>;
 }>;
 export type ApiIntegration = Omit<Merge<IntegrationConfig, ApiTimestamps>, 'oauth_client_secret_iv' | 'oauth_client_secret_tag'>;
 export type ApiIntegrationList = ApiIntegration & {
@@ -371,22 +361,22 @@ export type GetIntegrationFlows = ApiEndpoint<{
 }>;
 export type ApiPublicIntegrationCredentials = {
     type: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
-    client_id: string;
-    client_secret: string;
+    client_id?: string | undefined;
+    client_secret?: string | undefined;
     scopes?: string | undefined;
     webhook_secret?: string | undefined;
 } | {
     type: Extract<AuthModeType, 'APP'>;
-    app_id: string;
-    app_link: string;
-    private_key: string;
+    app_id?: string | undefined;
+    app_link?: string | undefined;
+    private_key?: string | undefined;
 } | {
     type: Extract<AuthModeType, 'CUSTOM'>;
-    client_id: string;
-    client_secret: string;
-    app_id: string;
-    app_link: string;
-    private_key: string;
+    client_id?: string | undefined;
+    client_secret?: string | undefined;
+    app_id?: string | undefined;
+    app_link?: string | undefined;
+    private_key?: string | undefined;
 } | {
     type: Extract<AuthModeType, 'MCP_OAUTH2_GENERIC'>;
     client_name?: string | undefined;

package/dist/meta/api.d.ts

@@ -31,6 +31,7 @@ export type GetMeta = ApiEndpoint<{
             toolsCatalog: boolean;
             accountGroup: AccountGroupProperties;
             agentPlayground: boolean;
+            hasBaa: boolean;
         };
     };
 }>;

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

@@ -313,3 +313,4 @@ export type PostPlanChange = ApiEndpoint<{
         };
     };
 }>;
+export type GrowthAddonState = 'none' | 'active' | 'pending-removal' | 'pending-activation';