@nangohq/types 0.46.0 → 0.47.0

package/dist/api.d.ts

@@ -11,7 +11,7 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'>;
+export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/api.endpoints.d.ts

@@ -8,13 +8,13 @@ import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup, GetE
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api';
 import type { GetUser, PatchUser } from './user/api';
 import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy, PatchIntegration, PostIntegration } from './integration/api';
-import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization, PostPublicJwtAuthorization, PostPublicBillAuthorization, PostPublicSignatureAuthorization, PostPublicTwoStepAuthorization } from './auth/http.api';
+import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization, PostPublicJwtAuthorization, PostPublicBillAuthorization, PostPublicSignatureAuthorization, PostPublicTwoStepAuthorization, PostPublicApiKeyAuthorization, PostPublicBasicAuthorization, PostPublicAppStoreAuthorization } from './auth/http.api';
 import type { GetPublicProvider, GetPublicProviders } from './providers/api';
-import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions } from './connect/api';
+import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect } from './connect/api';
 import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnections, PostConnectionRefresh } from './connection/api/get';
 import type { GetMeta } from './meta/api';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | GetPublicConnections | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization;
 export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PatchOnboarding | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**

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

@@ -9,7 +9,54 @@ export type ConnectionQueryString = {
 } | {
     connect_session_token: string;
 });
-type AuthErrors = ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'> | ApiError<'integration_not_allowed'>;
+export interface ConnectionResponse {
+    providerConfigKey: string;
+    connectionId: string;
+}
+type AuthErrors = ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'> | ApiError<'integration_not_allowed'> | ApiError<'invalid_connection'> | ApiError<'connection_test_failed'>;
+export type PostPublicApiKeyAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: {
+        apiKey: string;
+    };
+    Querystring: ConnectionQueryString;
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/api-auth/api-key/:providerConfigKey';
+    Error: AuthErrors;
+    Success: ConnectionResponse;
+}>;
+export type PostPublicAppStoreAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: {
+        privateKeyId: string;
+        privateKey: string;
+        issuerId: string;
+        scope?: string | undefined;
+    };
+    Querystring: ConnectionQueryString;
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/app-store-auth/:providerConfigKey';
+    Error: AuthErrors;
+    Success: ConnectionResponse;
+}>;
+export type PostPublicBasicAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: {
+        username: string;
+        password: string;
+    };
+    Querystring: ConnectionQueryString;
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/api-auth/basic/:providerConfigKey';
+    Error: AuthErrors;
+    Success: ConnectionResponse;
+}>;
 export type PostPublicTbaAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
@@ -24,10 +71,7 @@ export type PostPublicTbaAuthorization = Endpoint<{
     };
     Path: '/auth/tba/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export type PostPublicTableauAuthorization = Endpoint<{
     Method: 'POST';
@@ -42,10 +86,7 @@ export type PostPublicTableauAuthorization = Endpoint<{
     };
     Path: '/auth/tableau/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export type PostPublicJwtAuthorization = Endpoint<{
     Method: 'POST';
@@ -63,10 +104,7 @@ export type PostPublicJwtAuthorization = Endpoint<{
     };
     Path: '/auth/jwt/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export type PostPublicUnauthenticatedAuthorization = Endpoint<{
     Method: 'POST';
@@ -76,10 +114,7 @@ export type PostPublicUnauthenticatedAuthorization = Endpoint<{
     };
     Path: '/auth/unauthenticated/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export type PostPublicBillAuthorization = Endpoint<{
     Method: 'POST';
@@ -95,10 +130,7 @@ export type PostPublicBillAuthorization = Endpoint<{
     };
     Path: '/auth/bill/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export type PostPublicTwoStepAuthorization = Endpoint<{
     Method: 'POST';
@@ -109,10 +141,7 @@ export type PostPublicTwoStepAuthorization = Endpoint<{
     };
     Path: '/auth/two-step/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export type PostPublicSignatureAuthorization = Endpoint<{
     Method: 'POST';
@@ -126,9 +155,6 @@ export type PostPublicSignatureAuthorization = Endpoint<{
     };
     Path: '/auth/signature-based/:providerConfigKey';
     Error: AuthErrors;
-    Success: {
-        providerConfigKey: string;
-        connectionId: string;
-    };
+    Success: ConnectionResponse;
 }>;
 export {};

package/dist/connect/api.d.ts

@@ -1,8 +1,12 @@
 import type { Endpoint } from '../api.js';
-export interface ConnectSessionPayload {
+export interface ConnectSessionInput {
     allowed_integrations?: string[] | undefined;
     integrations_config_defaults?: Record<string, {
-        connection_config: Record<string, unknown>;
+        user_scopes?: string | undefined;
+        connection_config: {
+            [key: string]: unknown;
+            oauth_scopes_override?: string | undefined;
+        };
     }> | undefined;
     end_user: {
         id: string;
@@ -14,14 +18,34 @@ export interface ConnectSessionPayload {
         display_name?: string | undefined;
     } | undefined;
 }
+export type ConnectSessionOutput = ConnectSessionInput & {
+    isReconnecting?: boolean;
+};
 export type PostConnectSessions = Endpoint<{
     Method: 'POST';
     Path: '/connect/sessions';
-    Body: ConnectSessionPayload;
+    Body: ConnectSessionInput;
+    Success: {
+        data: {
+            token: string;
+            expires_at: string;
+        };
+    };
+}>;
+export type PostPublicConnectSessionsReconnect = Endpoint<{
+    Method: 'POST';
+    Path: '/connect/sessions/reconnect';
+    Body: {
+        connection_id: string;
+        integration_id: string;
+        integrations_config_defaults?: ConnectSessionInput['integrations_config_defaults'];
+        end_user?: ConnectSessionInput['end_user'] | undefined;
+        organization?: ConnectSessionInput['organization'];
+    };
     Success: {
         data: {
             token: string;
-            expires_at: Date;
+            expires_at: string;
         };
     };
 }>;
@@ -29,7 +53,7 @@ export type GetConnectSession = Endpoint<{
     Method: 'GET';
     Path: '/connect/session';
     Success: {
-        data: ConnectSessionPayload;
+        data: ConnectSessionOutput;
     };
 }>;
 export type DeleteConnectSession = Endpoint<{
@@ -41,5 +65,5 @@ export type PostInternalConnectSessions = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/connect/sessions';
     Success: PostConnectSessions['Success'];
-    Body: Pick<ConnectSessionPayload, 'allowed_integrations'>;
+    Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization'>;
 }>;

package/dist/connect/session.d.ts

@@ -3,9 +3,15 @@ export interface ConnectSession {
     readonly endUserId: number;
     readonly accountId: number;
     readonly environmentId: number;
-    readonly allowedIntegrations?: string[] | null;
-    readonly integrationsConfigDefaults?: Record<string, {
-        connectionConfig: Record<string, unknown>;
+    readonly connectionId: number | null;
+    readonly allowedIntegrations: string[] | null;
+    readonly integrationsConfigDefaults: Record<string, {
+        /** Only used by Slack */
+        user_scopes?: string | undefined;
+        connectionConfig: {
+            [key: string]: unknown;
+            oauth_scopes_override?: string | undefined;
+        };
     }> | null;
     readonly createdAt: Date;
     readonly updatedAt: Date | null;

package/dist/fleet/api.d.ts

@@ -0,0 +1,14 @@
+import type { Endpoint, ApiError } from '../api.js';
+import type { CommitHash, Deployment } from './index.js';
+export type PostRollout = Endpoint<{
+    Method: 'POST';
+    Path: '/fleet/:fleetId/rollout';
+    Body: {
+        commitHash: CommitHash;
+    };
+    Params: {
+        fleetId: string;
+    };
+    Success: Deployment;
+    Error: ApiError<'forbidden'> | ApiError<'rollout_failed'>;
+}>;

package/dist/fleet/index.d.ts

@@ -0,0 +1,10 @@
+export type CommitHash = string & {
+    readonly length: 40;
+};
+export interface Deployment {
+    readonly id: number;
+    readonly commitId: CommitHash;
+    readonly createdAt: Date;
+    readonly supersededAt: Date | null;
+}
+export type RoutingId = string;

package/dist/index.d.ts

@@ -50,3 +50,5 @@ export type * from './webhooks/api.js';
 export type * from './flow/http.api.js';
 export type * from './utils.js';
 export type * from './web/env.js';
+export type * from './fleet/api.js';
+export type * from './fleet/index.js';

package/dist/integration/api.d.ts

@@ -65,6 +65,14 @@ export type DeletePublicIntegration = Endpoint<{
         success: true;
     };
 }>;
+export type ApiIntegration = Omit<Merge<IntegrationConfig, ApiTimestamps>, 'oauth_client_secret_iv' | 'oauth_client_secret_tag'>;
+export type GetIntegrations = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/integrations';
+    Success: {
+        data: ApiIntegration[];
+    };
+}>;
 export type PostIntegration = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/integrations';
@@ -78,7 +86,6 @@ export type PostIntegration = Endpoint<{
         data: ApiIntegration;
     };
 }>;
-export type ApiIntegration = Omit<Merge<IntegrationConfig, ApiTimestamps>, 'oauth_client_secret_iv' | 'oauth_client_secret_tag'>;
 export type GetIntegration = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey';

package/dist/proxy/api.d.ts

@@ -39,6 +39,8 @@ export interface InternalProxyConfiguration {
 export interface RetryHeaderConfig {
     at?: string;
     after?: string;
+    remaining?: string;
+    error_code?: number;
 }
 export declare enum PaginationType {
     CURSOR = "cursor",

package/dist/utils.d.ts

@@ -13,4 +13,9 @@ export type PickFromUnion<T, U extends T> = ValidateSelection<T, U>;
 export type NullablePartial<TBase, TNullableKey extends keyof TBase = {
     [K in keyof TBase]: null extends TBase[K] ? K : never;
 }[keyof TBase]> = Partial<Pick<TBase, TNullableKey>> & Pick<TBase, Exclude<keyof TBase, TNullableKey>>;
+export type Jsonable = string | number | boolean | null | undefined | readonly Jsonable[] | {
+    readonly [key: string]: Jsonable;
+} | {
+    toJSON(): Jsonable;
+};
 export {};

package/package.json

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