@nangohq/types 0.69.13 → 0.69.15

package/dist/account/api.d.ts

@@ -24,7 +24,7 @@ export type ValidateEmailAndLogin = Endpoint<{
     Body: {
         token: string;
     };
-    Error: ApiError<'error_logging_in'> | ApiError<'error_validating_user'> | ApiError<'token_expired'> | ApiError<'error_refreshing_token'>;
+    Error: ApiError<'error_logging_in'> | ApiError<'error_validating_user'> | ApiError<'invalid_token'> | ApiError<'token_expired'> | ApiError<'error_refreshing_token'>;
     Success: {
         user: ApiUser;
     };

package/dist/api.endpoints.d.ts

@@ -18,7 +18,7 @@ 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';
 import type { PostPlanExtendTrial } from './plans/http.api.js';
-import type { GetPublicProvider, GetPublicProviders } from './providers/api.js';
+import type { GetProvider, GetProviders, GetPublicProvider, GetPublicProviders } from './providers/api.js';
 import type { AllPublicProxy } from './proxy/http.api.js';
 import type { GetPublicRecords } from './record/api.js';
 import type { GetPublicScriptsConfig } from './scripts/http.api.js';
@@ -28,7 +28,7 @@ import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api.js';
 import type { GetUser, PatchUser } 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 | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/auth/api.d.ts

@@ -130,6 +130,7 @@ export interface TwoStepCredentials extends CredentialsCommon {
     type: AuthModes['TwoStep'];
     [key: string]: any;
     token?: string;
+    refresh_token?: string;
     expires_at?: Date | undefined;
 }
 export interface SignatureCredentials {

package/dist/billing/types.d.ts

@@ -1,5 +1,6 @@
 import type { Result } from '../result.js';
 import type { DBTeam } from '../team/db.js';
+import type { UsageMetric } from '../usage/index.js';
 import type { DBUser } from '../user/db.js';
 export interface BillingClient {
     ingest: (events: BillingEvent[]) => Promise<Result<void>>;
@@ -9,7 +10,7 @@ export interface BillingClient {
     getCustomer: (accountId: number) => Promise<Result<BillingCustomer>>;
     getSubscription: (accountId: number) => Promise<Result<BillingSubscription | null>>;
     createSubscription: (team: DBTeam, planExternalId: string) => Promise<Result<BillingSubscription>>;
-    getUsage: (subscriptionId: string, opts?: GetBillingUsageOpts) => Promise<Result<BillingUsageMetric[]>>;
+    getUsage: (subscriptionId: string, opts?: GetBillingUsageOpts) => Promise<Result<BillingUsageMetrics>>;
     upgrade: (opts: {
         subscriptionId: string;
         planExternalId: string;
@@ -51,12 +52,11 @@ export interface GetBillingUsageOpts {
     granularity?: 'day';
     billingMetric?: {
         id: string;
-        group_by?: 'environmentId' | 'provider' | 'providerConfigKey' | 'connectionId' | 'type' | 'functionName' | 'model';
+        group_by?: 'environmentId' | 'environmentName' | 'integrationId' | 'type' | 'functionName' | 'model';
     };
 }
 export interface BillingUsageMetric {
-    id: string;
-    name: string;
+    externalId: string;
     group?: {
         key: string;
         value: string;
@@ -67,7 +67,13 @@ export interface BillingUsageMetric {
         timeframeEnd: Date;
         quantity: number;
     }[];
+    view_mode: 'cumulative' | 'periodic';
+}
+export type BillingUsageMetrics = Partial<Record<UsageMetric, BillingUsageMetric | undefined>>;
+export interface ApiBillingUsageMetric extends BillingUsageMetric {
+    label: string;
 }
+export type ApiBillingUsageMetrics = Record<UsageMetric, ApiBillingUsageMetric>;
 export interface BillingPlan {
     id: string;
     external_plan_id: string;
@@ -84,9 +90,9 @@ interface BillingEventBase<TType extends string, TProperties extends BillingProp
     } & TProperties;
 }
 export type MarBillingEvent = BillingEventBase<'monthly_active_records', {
-    connectionId: number;
     environmentId: number;
-    providerConfigKey: string;
+    environmentName: string;
+    integrationId: string;
     syncId: string;
     model: string;
 }>;
@@ -97,14 +103,17 @@ export type RecordsBillingEvent = BillingEventBase<'records', {
     };
 }>;
 export type ActionsBillingEvent = BillingEventBase<'billable_actions', {
-    connectionId: number;
     environmentId: number;
-    providerConfigKey: string;
+    environmentName: string;
+    integrationId: string;
     actionName: string;
 }>;
 export type FunctionExecutionsBillingEvent = BillingEventBase<'function_executions', {
+    environmentId: number;
+    environmentName: string;
+    integrationId: string;
     type: string;
-    connectionId: number;
+    functionName: string;
     telemetry: {
         successes: number;
         failures: number;
@@ -116,10 +125,9 @@ export type FunctionExecutionsBillingEvent = BillingEventBase<'function_executio
     frequencyMs?: number | undefined;
 }>;
 export type ProxyBillingEvent = BillingEventBase<'proxy', {
-    connectionId: number;
     environmentId: number;
-    providerConfigKey: string;
-    provider: string;
+    environmentName: string;
+    integrationId: string;
     telemetry: {
         successes: number;
         failures: number;
@@ -127,8 +135,8 @@ export type ProxyBillingEvent = BillingEventBase<'proxy', {
 }>;
 export type WebhookForwardBillingEvent = BillingEventBase<'webhook_forwards', {
     environmentId: number;
-    providerConfigKey: string;
-    provider: string;
+    environmentName: string;
+    integrationId: string;
     telemetry: {
         successes: number;
         failures: number;

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

@@ -1,5 +1,5 @@
-import type { BillingCustomer, BillingUsageMetric } from '../billing/types.js';
-import type { MetricUsageSummary } from '../usage/index.js';
+import type { ApiBillingUsageMetrics, BillingCustomer } from '../billing/types.js';
+import type { MetricUsageSummary, UsageMetric } from '../usage/index.js';
 import type { ReplaceInObject } from '../utils.js';
 import type { DBPlan } from './db.js';
 import type { Endpoint } from '../api.js';
@@ -58,7 +58,7 @@ export type GetUsage = Endpoint<{
         env: string;
     };
     Success: {
-        data: Record<string, MetricUsageSummary>;
+        data: Record<UsageMetric, MetricUsageSummary>;
     };
 }>;
 export type GetBillingUsage = Endpoint<{
@@ -66,12 +66,13 @@ export type GetBillingUsage = Endpoint<{
     Path: '/api/v1/plans/billing-usage';
     Querystring: {
         env: string;
+        from?: string | undefined;
+        to?: string | undefined;
     };
     Success: {
         data: {
             customer: BillingCustomer;
-            current: BillingUsageMetric[];
-            previous: BillingUsageMetric[];
+            usage: ApiBillingUsageMetrics;
         };
     };
 }>;

package/dist/providers/api.d.ts

@@ -1,5 +1,6 @@
 import type { Endpoint } from '../api.js';
 import type { Provider } from './provider.js';
+import type { AuthModeType } from '../auth/api.js';
 export type GetPublicProviders = Endpoint<{
     Method: 'GET';
     Path: `/providers`;
@@ -27,3 +28,30 @@ export type GetPublicProvider = Endpoint<{
         data: ApiProvider;
     };
 }>;
+export interface ApiProviderListItem {
+    name: string;
+    displayName: string;
+    defaultScopes?: string[] | undefined;
+    authMode: AuthModeType;
+    categories?: string[] | undefined;
+    docs: string;
+    preConfigured: boolean;
+    preConfiguredScopes: string[];
+}
+export type GetProviders = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/providers';
+    Success: {
+        data: ApiProviderListItem[];
+    };
+}>;
+export type GetProvider = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/providers/:providerConfigKey';
+    Params: {
+        providerConfigKey: string;
+    };
+    Success: {
+        data: ApiProviderListItem;
+    };
+}>;

package/dist/providers/provider.d.ts

@@ -175,10 +175,13 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
     };
     token_request_method?: 'GET';
     token_headers?: Record<string, string>;
+    refresh_url?: string;
+    refresh_token_params?: Record<string, string>;
     token_response: {
         token: string;
         token_expiration?: string;
         token_expiration_strategy?: 'expireAt' | 'expireIn';
+        refresh_token?: string;
     };
     additional_steps?: {
         body_format?: 'json' | 'form';

package/dist/proxy/api.d.ts

@@ -1,4 +1,5 @@
 import type { DBConnectionDecrypted } from '../connection/db.js';
+import type { DBIntegrationDecrypted } from '../integration/db.js';
 import type { HTTP_METHOD } from '../nangoYaml/index.js';
 import type { Provider } from '../providers/provider.js';
 import type { AxiosResponse } from 'axios';
@@ -32,6 +33,7 @@ export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
     paginate?: Partial<CursorPagination> | Partial<LinkPagination> | Partial<OffsetPagination>;
 }
 export type ConnectionForProxy = Pick<DBConnectionDecrypted, 'connection_id' | 'connection_config' | 'credentials' | 'metadata'>;
+export type IntegrationConfigForProxy = Pick<DBIntegrationDecrypted, 'oauth_client_id' | 'oauth_client_secret'>;
 export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfiguration {
     decompress: boolean;
     method: HTTP_METHOD;

package/dist/runner/sdk.d.ts

@@ -1,5 +1,6 @@
 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 { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse } from 'axios';
@@ -40,6 +41,7 @@ export interface NangoProps {
     } | null;
     heartbeatTimeoutSecs?: number | undefined;
     isCLI?: boolean | undefined;
+    integrationConfig?: IntegrationConfigForProxy;
     axios?: {
         request?: AxiosInterceptorManager<AxiosRequestConfig>;
         response?: {

package/dist/web/env.d.ts

@@ -10,6 +10,8 @@ export interface WindowEnv {
     publicLogoDevKey: string;
     publicStripeKey: string;
     isCloud: boolean;
+    isHosted: boolean;
+    isEnterprise: boolean;
     features: {
         logs: boolean;
         scripts: boolean;

package/dist/webhooks/api.d.ts

@@ -47,6 +47,7 @@ export interface NangoAuthWebhookBodyBase extends NangoWebhookBase {
     endUser?: {
         endUserId: string;
         organizationId?: string | undefined;
+        endUserEmail?: string | undefined | null;
         tags: Record<string, string>;
     } | undefined;
 }

package/package.json

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