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

Types used in Nango applications

export interface ApiError<TCode extends string, TErrors = any, TPayload = unknown> {
    error: {
        code: TCode;
        message?: string | undefined;
        errors?: TErrors;
        payload?: TPayload;
    };
}
export interface ValidationError {
    code: string;
    message: string;
    path: (string | number)[];
}
export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'disabled_resource'> | ApiError<'conflict'> | ApiError<'plan_limit'> | ApiError<'forbidden'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_headers', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'> | ApiError<'request_too_large'>;
export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
/**
 * API Request/Response type
 */
export interface EndpointDefinition {
    Method: EndpointMethod;
    Path: string;
    Params?: Record<string, any>;
    Body?: Record<string, any>;
    Headers?: Record<string, any>;
    Querystring?: Record<string, any>;
    Error?: ApiError<any> | never;
    Success: Record<string, any> | never;
}
export interface Endpoint<T extends EndpointDefinition> {
    Method: T['Method'];
    Path: T['Path'];
    /**
     * URL params
     */
    Params: T['Params'] extends Record<string, any> ? T['Params'] : never;
    /**
     * URL query string
     */
    Querystring: T['Querystring'] extends Record<string, any> ? T['Querystring'] : never;
    /**
     * Helpers: Querystring + Params
     */
    QP: (T['Params'] extends Record<string, any> ? T['Params'] : never) & (T['Querystring'] extends Record<string, any> ? T['Querystring'] : never);
    /**
     * Received body
     */
    Body: T['Body'] extends Record<string, any> ? T['Body'] : never;
    /**
     * Received headers
     */
    Headers: T['Headers'] extends Record<string, any> ? T['Headers'] : never;
    /**
     * Response body for success
     */
    Success: T['Success'];
    /**
     * Response body for any error
     */
    Errors: T['Error'] extends {
        error: any;
    } ? ResDefaultErrors | T['Error'] : ResDefaultErrors;
    /**
     * Response body (success + error)
     */
    Reply: ResDefaultErrors | (T['Error'] extends ApiError<any> ? T['Error'] | T['Success'] : T['Success']);
}
export interface ErrorPayload {
    type: string;
    description: string;
}
export interface ApiTimestamps {
    created_at: string;
    updated_at: string;
}