@nangohq/types 0.62.0 → 0.62.1

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

@@ -9,9 +9,29 @@ export type ConnectionQueryString = {
 } | {
     connect_session_token: string;
 });
-export interface ConnectionResponse {
+export interface ConnectionResponseSuccess {
     providerConfigKey: string;
     connectionId: string;
+    isPending?: boolean;
+}
+export type WebSocketConnectionMessage = WebSocketConnectionAck | WebSocketConnectionError | WebSocketConnectionResponseSuccess;
+export interface WebSocketConnectionAck {
+    message_type: 'connection_ack';
+    ws_client_id: string;
+}
+export interface WebSocketConnectionError {
+    message_type: 'error';
+    provider_config_key?: string | undefined;
+    connection_id?: string | undefined;
+    error_type: string;
+    error_desc: string;
+}
+export interface WebSocketConnectionResponseSuccess {
+    message_type: 'success';
+    provider_config_key: string;
+    connection_id: string;
+    is_pending: boolean;
+    private_key?: string | undefined;
 }
 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<{
@@ -25,7 +45,7 @@ export type PostPublicApiKeyAuthorization = Endpoint<{
     };
     Path: '/api-auth/api-key/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicAppStoreAuthorization = Endpoint<{
     Method: 'POST';
@@ -41,7 +61,7 @@ export type PostPublicAppStoreAuthorization = Endpoint<{
     };
     Path: '/app-store-auth/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicBasicAuthorization = Endpoint<{
     Method: 'POST';
@@ -55,7 +75,7 @@ export type PostPublicBasicAuthorization = Endpoint<{
     };
     Path: '/api-auth/basic/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicTbaAuthorization = Endpoint<{
     Method: 'POST';
@@ -71,7 +91,7 @@ export type PostPublicTbaAuthorization = Endpoint<{
     };
     Path: '/auth/tba/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicJwtAuthorization = Endpoint<{
     Method: 'POST';
@@ -82,7 +102,7 @@ export type PostPublicJwtAuthorization = Endpoint<{
     };
     Path: '/auth/jwt/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicUnauthenticatedAuthorization = Endpoint<{
     Method: 'POST';
@@ -92,7 +112,7 @@ export type PostPublicUnauthenticatedAuthorization = Endpoint<{
     };
     Path: '/auth/unauthenticated/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicBillAuthorization = Endpoint<{
     Method: 'POST';
@@ -108,7 +128,7 @@ export type PostPublicBillAuthorization = Endpoint<{
     };
     Path: '/auth/bill/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicTwoStepAuthorization = Endpoint<{
     Method: 'POST';
@@ -119,7 +139,7 @@ export type PostPublicTwoStepAuthorization = Endpoint<{
     };
     Path: '/auth/two-step/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicSignatureAuthorization = Endpoint<{
     Method: 'POST';
@@ -133,7 +153,7 @@ export type PostPublicSignatureAuthorization = Endpoint<{
     };
     Path: '/auth/signature-based/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export type PostPublicOauthOutboundAuthorization = Endpoint<{
     Method: 'POST';
@@ -147,6 +167,6 @@ export type PostPublicOauthOutboundAuthorization = Endpoint<{
     };
     Path: '/auth/oauth-outbound/:providerConfigKey';
     Error: AuthErrors;
-    Success: ConnectionResponse;
+    Success: ConnectionResponseSuccess;
 }>;
 export {};

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

@@ -3,6 +3,9 @@ import type { ScriptTypeLiteral } from '../nangoYaml/index.js';
 export type PutUpgradePreBuiltFlow = Endpoint<{
     Method: 'PUT';
     Path: '/api/v1/flows/pre-built/upgrade';
+    Querystring: {
+        env: string;
+    };
     Body: {
         id: number;
         provider: string;
@@ -20,13 +23,16 @@ export type PutUpgradePreBuiltFlow = Endpoint<{
 export type PostPreBuiltDeploy = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/flows/pre-built/deploy';
+    Querystring: {
+        env: string;
+    };
     Body: {
         provider: string;
         providerConfigKey: string;
         scriptName: string;
         type: ScriptTypeLiteral;
     };
-    Error: ApiError<'unknown_provider'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>;
+    Error: ApiError<'unknown_provider'> | ApiError<'failed_to_deploy', Error[]>;
     Success: {
         data: {
             id: number;
@@ -36,6 +42,9 @@ export type PostPreBuiltDeploy = Endpoint<{
 export type PatchFlowEnable = Endpoint<{
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/enable';
+    Querystring: {
+        env: string;
+    };
     Params: {
         id: number;
     };
@@ -55,6 +64,9 @@ export type PatchFlowEnable = Endpoint<{
 export type PatchFlowDisable = Endpoint<{
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/disable';
+    Querystring: {
+        env: string;
+    };
     Params: {
         id: number;
     };
@@ -74,6 +86,9 @@ export type PatchFlowDisable = Endpoint<{
 export type PatchFlowFrequency = Endpoint<{
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/frequency';
+    Querystring: {
+        env: string;
+    };
     Params: {
         id: number;
     };

package/dist/flow/index.d.ts

@@ -25,6 +25,8 @@ export interface NangoSyncConfig {
     enabled?: boolean;
     json_schema: JSONSchema7 | null;
     upgrade_version?: string;
+    is_zero_yaml: boolean;
+    sdk_version: string | null;
 }
 export interface StandardNangoConfig {
     providerConfigKey: string;

package/dist/nangoYaml/index.d.ts

@@ -1,4 +1,5 @@
 import type { OnEventType } from '../scripts/on-events/api.js';
+import type { JSONSchema7 } from 'json-schema';
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export type SyncTypeLiteral = 'incremental' | 'full';
 export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'post-connection-scripts';
@@ -126,10 +127,15 @@ export type NangoSyncEndpointOld = Partial<Record<HTTP_METHOD, string | undefine
 export interface NangoSyncEndpointV2 {
     method: HTTP_METHOD;
     path: string;
-    group?: string | undefined;
+    group?: string | null | undefined;
 }
 export interface FlowsYaml {
     integrations: Record<string, NangoYamlV2Integration & {
         models: NangoYamlModel;
     }>;
 }
+export type FlowZeroJson = NangoYamlParsedIntegration & {
+    jsonSchema: JSONSchema7;
+    sdkVersion: string;
+};
+export type FlowsZeroJson = FlowZeroJson[];

package/dist/user/api.d.ts

@@ -23,3 +23,14 @@ export interface ApiUser {
     name: string;
     uuid: string;
 }
+export type PutUserPassword = Endpoint<{
+    Method: 'PUT';
+    Path: `/api/v1/user/password`;
+    Body: {
+        oldPassword: string;
+        newPassword: string;
+    };
+    Success: {
+        success: true;
+    };
+}>;

package/package.json

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