@nangohq/types/dist/flow/http.api.d.ts

Types used in Nango applications

import type { ApiError, Endpoint } from '../api';
import type { ScriptTypeLiteral } from '../nangoYaml';
export type PutUpgradePreBuiltFlow = Endpoint<{
    Method: 'PUT';
    Path: '/api/v1/flows/pre-built/upgrade';
    Body: {
        id: number;
        provider: string;
        scriptName: string;
        type: ScriptTypeLiteral;
        upgradeVersion: string;
        lastDeployed: string;
        providerConfigKey: string;
    };
    Error: ApiError<'upgrade_failed'> | ApiError<'unknown_provider'> | ApiError<'unknown_sync_config'> | ApiError<'unknown_flow'> | ApiError<'invalid_version'>;
    Success: {
        success: true;
    };
}>;
export type PostPreBuiltDeploy = Endpoint<{
    Method: 'POST';
    Path: '/api/v1/flows/pre-built/deploy';
    Body: {
        provider: string;
        providerConfigKey: string;
        scriptName: string;
        type: ScriptTypeLiteral;
    };
    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;
        };
    };
}>;