@nangohq/types 0.47.1 → 0.48.1

package/dist/api.endpoints.d.ts

@@ -11,10 +11,11 @@ import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetInt
 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, PostPublicConnectSessionsReconnect } from './connect/api';
-import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnections, PostConnectionRefresh } from './connection/api/get';
+import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, 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 | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization;
+import type { PostPublicWebhook } from './webhooks/http.api';
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook;
 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/connection/api/get.d.ts

@@ -3,12 +3,13 @@ import type { DBConnection } from '../db.js';
 import type { ActiveLog } from '../../notification/active-logs/db.js';
 import type { Merge } from 'type-fest';
 import type { ApiEndUser } from '../../endUser/index.js';
+import type { AllAuthCredentials } from '../../auth/api.js';
 export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id' | 'connection_id' | 'provider_config_key' | 'created_at' | 'updated_at'> & {
     provider: string;
-    errors: [{
+    errors: {
         type: string;
         log_id: string;
-    }];
+    }[];
     endUser: ApiEndUser | null;
 };
 export type GetConnections = Endpoint<{
@@ -44,16 +45,19 @@ export type ApiPublicConnection = Pick<DBConnection, 'id' | 'connection_id' | 'p
     created: string;
     metadata: Record<string, unknown> | null;
     provider: string;
-    errors: [{
+    errors: {
         type: string;
         log_id: string;
-    }];
+    }[];
+    end_user: ApiEndUser | null;
 };
 export type GetPublicConnections = Endpoint<{
     Method: 'GET';
     Querystring: {
         connectionId?: string | undefined;
         search?: string | undefined;
+        endUserId?: string | undefined;
+        endUserOrganizationId?: string | undefined;
     };
     Path: '/connection';
     Success: {
@@ -81,6 +85,33 @@ export type GetConnection = Endpoint<{
         };
     };
 }>;
+export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key' | 'connection_config'> & {
+    created_at: string;
+    updated_at: string;
+    last_fetched_at: string;
+    metadata: Record<string, unknown> | null;
+    provider: string;
+    errors: {
+        type: string;
+        log_id: string;
+    }[];
+    end_user: ApiEndUser | null;
+    credentials: AllAuthCredentials;
+};
+export type GetPublicConnection = Endpoint<{
+    Method: 'GET';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        provider_config_key: string;
+        refresh_token?: boolean | undefined;
+        force_refresh?: boolean | undefined;
+    };
+    Path: '/connection/:connectionId';
+    Error: ApiError<'unknown_provider_config'>;
+    Success: ApiPublicConnectionFull;
+}>;
 export type PostConnectionRefresh = Endpoint<{
     Method: 'POST';
     Params: {

package/dist/index.d.ts

@@ -47,6 +47,7 @@ export type * from './environment/db.js';
 export type * from './environment/api/webhook.js';
 export type * from './environment/api/otlp.js';
 export type * from './webhooks/api.js';
+export type * from './webhooks/http.api.js';
 export type * from './flow/http.api.js';
 export type * from './utils.js';
 export type * from './web/env.js';

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

@@ -0,0 +1,11 @@
+import type { ApiError, Endpoint } from '../api';
+export type PostPublicWebhook = Endpoint<{
+    Method: 'POST';
+    Path: '/webhook/:environmentUuid/:providerConfigKey';
+    Params: {
+        environmentUuid: string;
+        providerConfigKey: string;
+    };
+    Error: ApiError<'unknown_environment'> | ApiError<'unknown_provider_config'>;
+    Success: any;
+}>;

package/package.json

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