@nangohq/types 0.42.8 → 0.42.10

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<'missing_auth_header'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'>;
+export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'missing_auth_header'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/connection/api/get.d.ts

@@ -19,3 +19,32 @@ export type GetConnection = Endpoint<{
         errorLog: ActiveLog | null;
     };
 }>;
+export type DeletePublicConnection = Endpoint<{
+    Method: 'DELETE';
+    Path: '/connection/:connectionId';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        provider_config_key: string;
+    };
+    Error: ApiError<'unknown_connection'> | ApiError<'unknown_provider_config'>;
+    Success: {
+        success: boolean;
+    };
+}>;
+export type DeleteConnection = Endpoint<{
+    Method: 'DELETE';
+    Path: '/connection/:connectionId';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        provider_config_key: string;
+        env: string;
+    };
+    Error: ApiError<'unknown_connection'> | ApiError<'unknown_provider_config'>;
+    Success: {
+        success: boolean;
+    };
+}>;

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,17 +19,75 @@ 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;
         scriptName: string;
         type: ScriptTypeLiteral;
     };
-    Error: ApiError<'unknown_provider'> | ApiError<'resource_capped'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>;
+    Error: ApiError<'unknown_provider'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>;
     Success: {
         data: {
             id: number;
         };
     };
 }>;
+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,12 +14,15 @@ 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';
 export type * from './environment/db.js';
 export type * from './scripts/post-connection/db.js';
 export type * from './scripts/syncs/api.js';
+export type * from './slackNotifications/db.js';
 export type * from './notification/active-logs/db.js';
 export type * from './connection/api/get.js';
 export type * from './integration/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/logs/api.d.ts

@@ -1,8 +1,10 @@
 import type { Endpoint } from '../api';
 import type { MessageRow, MessageState, OperationList, OperationRow } from './messages';
-type Concat<T extends OperationList> = T[keyof T] | (T extends {
+type Concat<T extends OperationList> = T extends {
     action: string;
-} ? `${T['type']}:${T['action']}` : never);
+} ? `${T['type']}:${T['action']}` : never;
+export type ConcatOperationList = Concat<OperationList>;
+export type ConcatOperationListWithGroup = OperationList[keyof OperationList] | ConcatOperationList;
 export type SearchOperations = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/logs/operations';
@@ -28,7 +30,7 @@ export type SearchOperations = Endpoint<{
     };
 }>;
 export type SearchOperationsState = 'all' | MessageState;
-export type SearchOperationsType = 'all' | Concat<OperationList>;
+export type SearchOperationsType = 'all' | ConcatOperationListWithGroup;
 export type SearchOperationsIntegration = 'all' | string;
 export type SearchOperationsConnection = 'all' | string;
 export type SearchOperationsSync = 'all' | string;

package/dist/logs/messages.d.ts

@@ -31,9 +31,11 @@ export interface OperationSync {
 }
 export interface OperationProxy {
     type: 'proxy';
+    action: 'call';
 }
 export interface OperationAction {
     type: 'action';
+    action: 'run';
 }
 export interface OperationAuth {
     type: 'auth';
@@ -113,11 +115,11 @@ export interface MessageRow {
 /**
  * What is required to insert a Message
  */
-export type OperationRowInsert = Merge<Partial<MessageRow>, {
-    message: string;
+export type OperationRowInsert = Omit<Merge<Partial<MessageRow>, {
     operation: OperationList;
-}>;
+}>, 'message'>;
 export type OperationRow = Merge<Required<OperationRowInsert>, {
+    message: string;
     accountId: number;
     accountName: string;
 }>;
@@ -127,5 +129,4 @@ export type OperationRow = Merge<Required<OperationRowInsert>, {
 export type MessageRowInsert = Pick<MessageRow, 'type' | 'message'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
     id?: never;
 };
-export type LogsBuffer = Pick<MessageRow, 'level' | 'message' | 'createdAt'> & Partial<Pick<MessageRow, 'error' | 'meta' | 'type' | 'request' | 'response'>>;
 export type MessageOrOperationRow = MessageRow | OperationRow;

package/dist/slackNotifications/db.d.ts

@@ -0,0 +1,11 @@
+import type { Timestamps } from '../db';
+export interface DBSlackNotification extends Timestamps {
+    id: number;
+    open: boolean;
+    environment_id: number;
+    name: string;
+    type: string;
+    connection_list: number[];
+    slack_timestamp: string | null;
+    admin_slack_timestamp: string | null;
+}

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.8",
+    "version": "0.42.10",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",