@nangohq/types 0.42.9 → 0.42.10

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,6 +14,8 @@ 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 './proxy/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 { Template } from './template';
+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: Template;
+            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/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.10",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",