n8n/dist/credentials/credentials.controller.d.ts

n8n Workflow Automation Tool

import { CreateCredentialDto, CredentialsGetManyRequestQuery, CredentialsGetOneRequestQuery, GenerateCredentialNameRequestQuery } from '@n8n/api-types';
import { LicenseState, Logger } from '@n8n/backend-common';
import { GlobalConfig } from '@n8n/config';
import { ProjectRelationRepository, SharedCredentialsRepository, AuthenticatedRequest } from '@n8n/db';
import { CredentialConnectionStatusProxy } from './credential-connection-status-proxy';
import { CredentialsFinderService } from './credentials-finder.service';
import { CredentialsService } from './credentials.service';
import { EnterpriseCredentialsService } from './credentials.service.ee';
import { CredentialsOverwrites } from '../credentials-overwrites';
import { EventService } from '../events/event.service';
import { CredentialRequest } from '../requests';
import { NamingService } from '../services/naming.service';
import { UserManagementMailer } from '../user-management/email';
export declare class CredentialsController {
    private readonly globalConfig;
    private readonly credentialsService;
    private readonly enterpriseCredentialsService;
    private readonly namingService;
    private readonly licenseState;
    private readonly logger;
    private readonly userManagementMailer;
    private readonly sharedCredentialsRepository;
    private readonly projectRelationRepository;
    private readonly eventService;
    private readonly credentialsFinderService;
    private readonly connectionStatusProxy;
    private readonly credentialsOverwrites;
    constructor(globalConfig: GlobalConfig, credentialsService: CredentialsService, enterpriseCredentialsService: EnterpriseCredentialsService, namingService: NamingService, licenseState: LicenseState, logger: Logger, userManagementMailer: UserManagementMailer, sharedCredentialsRepository: SharedCredentialsRepository, projectRelationRepository: ProjectRelationRepository, eventService: EventService, credentialsFinderService: CredentialsFinderService, connectionStatusProxy: CredentialConnectionStatusProxy, credentialsOverwrites: CredentialsOverwrites);
    getMany(req: CredentialRequest.GetMany, _res: unknown, query: CredentialsGetManyRequestQuery): Promise<import("@n8n/db").CredentialsEntity[]>;
    getProjectCredentials(req: CredentialRequest.ForWorkflow): Promise<{
        id: string;
        name: string;
        type: string;
        createdAt: string;
        updatedAt: string;
        scopes: import("@n8n/permissions").Scope[];
        isManaged: boolean;
        isGlobal: boolean;
        isResolvable: boolean;
        homeProject: import("@n8n/db").SlimProject | null;
        sharedWithProjects: import("@n8n/db").SlimProject[];
        currentUserHasAccess: boolean;
        connectedByMe?: boolean;
    }[]>;
    generateUniqueName(_req: unknown, _res: unknown, query: GenerateCredentialNameRequestQuery): Promise<{
        name: string;
    }>;
    getOne(req: CredentialRequest.Get, _res: unknown, credentialId: string, query: CredentialsGetOneRequestQuery): Promise<{
        id: string;
        generateId(): void;
        createdAt: Date;
        updatedAt: Date;
        setUpdateDate(): void;
        name: string;
        type: string;
        isManaged: boolean;
        isGlobal: boolean;
        isResolvable: boolean;
        resolvableAllowFallback: boolean;
        resolverId: string | null;
        usageScope: import("@n8n/db").CredentialUsageScope;
        connectedByMe?: boolean;
        connectedUserCount?: number;
        scopes: import("@n8n/permissions").Scope[];
    }>;
    testCredentials(req: CredentialRequest.Test): Promise<import("n8n-workflow").INodeCredentialTestResult>;
    createCredentials(req: AuthenticatedRequest, _: Response, payload: CreateCredentialDto): Promise<{
        id: string;
        generateId(): void;
        createdAt: Date;
        updatedAt: Date;
        setUpdateDate(): void;
        name: string;
        data: string;
        type: string;
        isManaged: boolean;
        isGlobal: boolean;
        isResolvable: boolean;
        resolvableAllowFallback: boolean;
        resolverId: string | null;
        usageScope: import("@n8n/db").CredentialUsageScope;
        scopes: import("@n8n/permissions").Scope[];
    }>;
    updateCredentials(req: CredentialRequest.Update): Promise<{
        id: string;
        generateId(): void;
        createdAt: Date;
        updatedAt: Date;
        setUpdateDate(): void;
        name: string;
        type: string;
        isManaged: boolean;
        isGlobal: boolean;
        isResolvable: boolean;
        resolvableAllowFallback: boolean;
        resolverId: string | null;
        usageScope: import("@n8n/db").CredentialUsageScope;
        scopes: import("@n8n/permissions").Scope[];
    }>;
    disconnectOauthToken(req: AuthenticatedRequest, _res: unknown, credentialId: string): Promise<{
        success: boolean;
    }>;
    deleteCredentials(req: CredentialRequest.Delete): Promise<boolean>;
    shareCredentials(req: CredentialRequest.Share): Promise<void>;
    transfer(req: CredentialRequest.Transfer): Promise<void>;
}