@nangohq/types 0.70.8 → 0.70.9

package/dist/api.endpoints.d.ts

@@ -4,9 +4,9 @@ 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 { 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 { 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';

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 {
@@ -120,9 +121,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 +162,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/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/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/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;

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';

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 { Provider, SimplifiedJSONSchema } from './provider.js';
 export type GetPublicProviders = Endpoint<{
     Method: 'GET';
     Path: `/providers`;

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,8 +1,8 @@
-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';

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.70.9",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",