@nangohq/types 0.42.9 → 0.42.11

package/dist/api.endpoints.d.ts

@@ -8,7 +8,11 @@ import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup } fro
 import type { DeleteInvite, PostInvite } from './invitations/api';
 import type { GetUser, PatchUser } from './user/api';
 import type { GetListIntegrations } from './integration/api';
-export type APIEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | GetListIntegrations;
+import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api';
+import type { GetPublicProvider, GetPublicProviders } from './providers/api';
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider;
+export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | GetListIntegrations;
+export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path
  */

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

@@ -1,43 +1,62 @@
 import type { ApiError, Endpoint } from '../api';
-import type { ConnectionConfig } from '../connection/db';
-export type TbaAuthorization = Endpoint<{
+export type PostPublicTbaAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
         token_id: string;
         token_secret: string;
-        oauth_client_id_override?: string;
-        oauth_client_secret_override?: string;
+        oauth_client_id_override?: string | undefined;
+        oauth_client_secret_override?: string | undefined;
     };
-    QueryParams: {
-        connectionId: string;
-        connectionConfig: ConnectionConfig;
+    Querystring: {
+        connection_id: string;
+        public_key: string;
+        params?: Record<string, any> | undefined;
+        hmac?: string | undefined;
     };
     Params: {
         providerConfigKey: string;
     };
     Path: '/auth/tba';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
         connectionId: string;
     };
 }>;
-export type TableauAuthorization = Endpoint<{
+export type PostPublicTableauAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
         pat_name: string;
         pat_secret: string;
-        content_url?: string;
+        content_url?: string | undefined;
     };
-    QueryParams: {
-        connectionId: string;
-        connectionConfig: ConnectionConfig;
+    Querystring: {
+        connection_id: string;
+        public_key: string;
+        params?: Record<string, any> | undefined;
+        hmac?: string | undefined;
     };
     Params: {
         providerConfigKey: string;
     };
     Path: '/auth/tableau';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Success: {
+        providerConfigKey: string;
+        connectionId: string;
+    };
+}>;
+export type PostPublicUnauthenticatedAuthorization = Endpoint<{
+    Method: 'POST';
+    Querystring: {
+        connection_id: string;
+        hmac?: string | undefined;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/auth/unauthenticated';
+    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
         connectionId: string;

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

@@ -2,7 +2,7 @@ import type { ApiError, Endpoint } from '../api';
 import type { ScriptTypeLiteral } from '../nangoYaml';
 export type PutUpgradePreBuiltFlow = Endpoint<{
     Method: 'PUT';
-    Path: '/api/v1/flow/pre-built/upgrade';
+    Path: '/api/v1/flows/pre-built/upgrade';
     Body: {
         id: number;
         provider: string;
@@ -19,7 +19,7 @@ export type PutUpgradePreBuiltFlow = Endpoint<{
 }>;
 export type PostPreBuiltDeploy = Endpoint<{
     Method: 'POST';
-    Path: '/api/v1/flow/pre-built/deploy';
+    Path: '/api/v1/flows/pre-built/deploy';
     Body: {
         provider: string;
         providerConfigKey: string;
@@ -33,3 +33,61 @@ export type PostPreBuiltDeploy = Endpoint<{
         };
     };
 }>;
+export type PatchFlowEnable = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/flows/:id/enable';
+    Params: {
+        id: number;
+    };
+    Body: {
+        provider: string;
+        providerConfigKey: string;
+        scriptName: string;
+        type: ScriptTypeLiteral;
+    };
+    Error: ApiError<'unknown_provider'> | ApiError<'resource_capped'> | ApiError<'unknown_sync_config'>;
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;
+export type PatchFlowDisable = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/flows/:id/disable';
+    Params: {
+        id: number;
+    };
+    Body: {
+        provider: string;
+        providerConfigKey: string;
+        scriptName: string;
+        type: ScriptTypeLiteral;
+    };
+    Error: ApiError<'unknown_provider'>;
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;
+export type PatchFlowFrequency = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/flows/:id/frequency';
+    Params: {
+        id: number;
+    };
+    Body: {
+        provider: string;
+        providerConfigKey: string;
+        scriptName: string;
+        type: ScriptTypeLiteral;
+        frequency: string;
+    };
+    Error: ApiError<'unknown_provider'> | ApiError<'unknown_sync_config'> | ApiError<'failed_to_update_frequency'>;
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;

package/dist/index.d.ts

@@ -14,8 +14,11 @@ export type * from './connection/db.js';
 export type * from './meta/api.js';
 export type * from './invitations/api.js';
 export type * from './invitations/db.js';
+export type * from './syncConfigs/db.js';
+export type * from './syncConfigs/api.js';
 export type * from './team/api.js';
 export type * from './team/db.js';
+export type * from './providers/api.js';
 export type * from './proxy/api.js';
 export type * from './environment/db.js';
 export type * from './scripts/post-connection/db.js';
@@ -25,7 +28,7 @@ export type * from './notification/active-logs/db.js';
 export type * from './connection/api/get.js';
 export type * from './integration/api.js';
 export type * from './integration/db.js';
-export type * from './integration/template.js';
+export type * from './providers/provider.js';
 export type * from './auth/api.js';
 export type * from './auth/db.js';
 export type * from './auth/http.api.js';

package/dist/integration/api.d.ts

@@ -1,4 +1,12 @@
-import type { Endpoint } from '../api';
+import type { Merge } from 'type-fest';
+import type { ApiTimestamps, Endpoint } from '../api';
+import type { IntegrationConfig } from './db';
+import type { Provider } from '../providers/provider';
+import type { AuthModeType } from '../auth/api';
+import type { NangoModel, NangoSyncEndpoint, ScriptTypeLiteral } from '../nangoYaml';
+import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
+import type { JSONSchema7 } from 'json-schema';
+import type { SyncType } from '../scripts/syncs/api';
 export type GetListIntegrations = Endpoint<{
     Method: 'GET';
     Path: '/config';
@@ -19,9 +27,70 @@ export type DeleteIntegrationPublic = Endpoint<{
         success: true;
     };
 }>;
+export type PostIntegration = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/integrations';
+    Body: {
+        provider: string;
+    };
+    Success: {
+        data: ApiIntegration;
+    };
+}>;
+export type ApiIntegration = Merge<IntegrationConfig, ApiTimestamps>;
+export type GetIntegration = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/integrations/:providerConfigKey';
+    Params: {
+        providerConfigKey: string;
+    };
+    Success: {
+        data: {
+            integration: ApiIntegration;
+            template: Provider;
+            meta: {
+                connectionsCount: number;
+                webhookUrl: string | null;
+                webhookSecret: string | null;
+            };
+        };
+    };
+}>;
+export type PatchIntegration = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/integrations/:providerConfigKey';
+    Params: {
+        providerConfigKey: string;
+    };
+    Body: {
+        integrationId?: string | undefined;
+    } | {
+        authType: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
+        clientId: string;
+        clientSecret: string;
+        scopes?: string | undefined;
+    } | {
+        authType: Extract<AuthModeType, 'APP'>;
+        appId: string;
+        appLink: string;
+        privateKey: string;
+    } | {
+        authType: Extract<AuthModeType, 'CUSTOM'>;
+        clientId: string;
+        clientSecret: string;
+        appId: string;
+        appLink: string;
+        privateKey: string;
+    };
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;
 export type DeleteIntegration = Endpoint<{
     Method: 'DELETE';
-    Path: '/api/v1/integration/:providerConfigKey';
+    Path: '/api/v1/integrations/:providerConfigKey';
     Params: {
         providerConfigKey: string;
     };
@@ -31,3 +100,41 @@ export type DeleteIntegration = Endpoint<{
         };
     };
 }>;
+export interface NangoSyncConfig {
+    name: string;
+    type?: ScriptTypeLiteral;
+    runs: string;
+    auto_start?: boolean;
+    attributes?: object;
+    description?: string;
+    scopes?: string[];
+    metadata?: NangoConfigMetadata;
+    track_deletes?: boolean;
+    returns: string[] | string;
+    models: any[];
+    endpoints: NangoSyncEndpoint[];
+    is_public?: boolean | null;
+    pre_built?: boolean | null;
+    version?: string | null;
+    last_deployed?: string | null;
+    id?: number;
+    input?: NangoModel | LegacySyncModelSchema;
+    sync_type?: SyncType;
+    nango_yaml_version?: string;
+    webhookSubscriptions?: string[];
+    enabled?: boolean;
+    json_schema: JSONSchema7 | null;
+    upgrade_version?: string;
+}
+export type GetIntegrationFlows = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/integrations/:providerConfigKey/flows';
+    Params: {
+        providerConfigKey: string;
+    };
+    Success: {
+        data: {
+            flows: NangoSyncConfig[];
+        };
+    };
+}>;

package/dist/providers/api.d.ts

@@ -0,0 +1,25 @@
+import type { Endpoint } from '../api';
+import type { Provider } from './provider';
+export type GetPublicProviders = Endpoint<{
+    Method: 'GET';
+    Path: `/providers`;
+    Querystring: {
+        search?: string | undefined;
+    };
+    Success: {
+        data: ApiProvider[];
+    };
+}>;
+export type ApiProvider = Provider & {
+    name: string;
+};
+export type GetPublicProvider = Endpoint<{
+    Method: 'GET';
+    Path: `/providers/:provider`;
+    Params: {
+        provider: string;
+    };
+    Success: {
+        data: ApiProvider;
+    };
+}>;

package/dist/{integration/template.d.ts → providers/provider.d.ts}

@@ -12,7 +12,13 @@ export interface TokenUrlObject {
     APP?: string;
     NONE?: string;
 }
-export interface Template {
+export interface ProviderAlias {
+    alias?: string;
+    proxy: {
+        base_url?: string;
+    };
+}
+export interface BaseProvider {
     auth_mode: AuthModeType;
     proxy?: {
         base_url: string;
@@ -49,7 +55,7 @@ export interface Template {
     categories?: string[];
     connection_configuration?: string[];
 }
-export interface TemplateOAuth2 extends Template {
+export interface ProviderOAuth2 extends BaseProvider {
     auth_mode: 'OAUTH2' | 'CUSTOM';
     disable_pkce?: boolean;
     token_params?: {
@@ -64,7 +70,7 @@ export interface TemplateOAuth2 extends Template {
     expires_in_unit?: 'milliseconds';
     token_request_auth_method?: 'basic' | 'custom';
 }
-export interface TemplateOAuth1 extends Template {
+export interface ProviderOAuth1 extends BaseProvider {
     auth_mode: 'OAUTH1';
     request_url: string;
     request_params?: Record<string, string>;
@@ -72,3 +78,4 @@ export interface TemplateOAuth1 extends Template {
     token_http_method?: 'GET' | 'PUT' | 'POST';
     signature_method: 'HMAC-SHA1' | 'RSA-SHA1' | 'PLAINTEXT';
 }
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2;

package/dist/proxy/api.d.ts

@@ -2,7 +2,7 @@ import type { ParamsSerializerOptions } from 'axios';
 import type { EndpointMethod } from '../api.js';
 import type { BasicApiCredentials, ApiKeyCredentials, AppCredentials } from '../auth/api.js';
 import type { Connection } from '../connection/db.js';
-import type { Template as ProviderTemplate } from '../integration/template.js';
+import type { Provider } from '../providers/provider.js';
 export interface BaseProxyConfiguration {
     providerConfigKey: string;
     connectionId: string;
@@ -25,16 +25,16 @@ export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
 export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfiguration {
     decompress?: boolean;
     method: EndpointMethod;
-    provider: string;
+    providerName: string;
     token: string | BasicApiCredentials | ApiKeyCredentials | AppCredentials;
-    template: ProviderTemplate;
+    provider: Provider;
     connection: Connection;
 }
 export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 export interface InternalProxyConfiguration {
-    provider: string;
+    providerName: string;
     connection: Connection;
-    existingActivityLogId?: number | null;
+    existingActivityLogId?: string | null | undefined;
 }
 export interface RetryHeaderConfig {
     at?: string;

package/dist/syncConfigs/api.d.ts

@@ -0,0 +1,4 @@
+import type { Merge } from 'type-fest';
+import type { ApiTimestamps } from '../api';
+import type { DBSyncConfig } from './db';
+export type ApiSyncConfig = Merge<DBSyncConfig, ApiTimestamps>;

package/dist/syncConfigs/db.d.ts

@@ -0,0 +1,28 @@
+import type { JSONSchema7 } from 'json-schema';
+import type { TimestampsAndDeleted } from '../db';
+import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
+import type { NangoModel, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+export interface DBSyncConfig extends TimestampsAndDeleted {
+    id: number;
+    sync_name: string;
+    nango_config_id: number;
+    file_location: string;
+    version: string;
+    models: string[] | null;
+    active: boolean;
+    runs: string | null;
+    model_schema: LegacySyncModelSchema[] | NangoModel[] | null;
+    environment_id: number;
+    track_deletes: boolean;
+    type: ScriptTypeLiteral;
+    auto_start: boolean;
+    attributes: object;
+    pre_built: boolean;
+    is_public: boolean;
+    metadata: NangoConfigMetadata;
+    input: string | undefined;
+    sync_type: SyncTypeLiteral | undefined;
+    webhook_subscriptions: string[] | null;
+    enabled: boolean;
+    models_json_schema: JSONSchema7 | null;
+}

package/package.json

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