import type { ProjectIcon, ProjectType } from '@n8n/api-types'; import type { Variables, Project, User, ListQueryDb, WorkflowHistory } from '@n8n/db'; import type { AssignableGlobalRole, GlobalRole, ProjectRole, Scope } from '@n8n/permissions'; import type express from 'express'; import type { ICredentialDataDecryptedObject, INodeCredentialTestRequest, IPersonalizationSurveyAnswersV4 } from 'n8n-workflow'; export type APIRequest = express.Request & { browserId?: string; }; export type AuthlessRequest = APIRequest; export type AuthenticatedRequest = Omit, 'user' | 'cookies'> & { user: User; cookies: Record; headers: express.Request['headers'] & { 'push-ref': string; }; }; export declare namespace ListQuery { type Request = AuthenticatedRequest<{}, {}, {}, Params> & { listQueryOptions?: Options; }; type Params = { filter?: string; skip?: string; take?: string; select?: string; sortBy?: string; }; type Options = { filter?: Record; select?: Record; skip?: number; take?: number; sortBy?: string; }; } export declare function hasSharing(workflows: ListQueryDb.Workflow.Plain[] | ListQueryDb.Workflow.WithSharing[]): workflows is ListQueryDb.Workflow.WithSharing[]; export declare namespace CredentialRequest { type CredentialProperties = Partial<{ id: string; name: string; type: string; data: ICredentialDataDecryptedObject; projectId?: string; isManaged?: boolean; }>; type Get = AuthenticatedRequest<{ credentialId: string; }, {}, {}, Record>; type GetMany = AuthenticatedRequest<{}, {}, {}, ListQuery.Params & { includeScopes?: string; includeFolders?: string; }> & { listQueryOptions: ListQuery.Options; }; type Delete = Get; type GetAll = AuthenticatedRequest<{}, {}, {}, { filter: string; }>; type Update = AuthenticatedRequest<{ credentialId: string; }, {}, CredentialProperties>; type Test = AuthenticatedRequest<{}, {}, INodeCredentialTestRequest>; type Share = AuthenticatedRequest<{ credentialId: string; }, {}, { shareWithIds: string[]; }>; type Transfer = AuthenticatedRequest<{ credentialId: string; }, {}, { destinationProjectId: string; }>; type ForWorkflow = AuthenticatedRequest<{}, {}, {}, { workflowId: string; } | { projectId: string; }>; } export declare namespace MeRequest { type SurveyAnswers = AuthenticatedRequest<{}, {}, IPersonalizationSurveyAnswersV4>; } export declare namespace UserRequest { type InviteResponse = { user: { id: string; email: string; inviteAcceptUrl?: string; emailSent: boolean; role: AssignableGlobalRole; }; error?: string; }; type Delete = AuthenticatedRequest<{ id: string; email: string; identifier: string; }, {}, {}, { transferId?: string; includeRole: boolean; }>; type Get = AuthenticatedRequest<{ id: string; email: string; identifier: string; }, {}, {}, { limit?: number; offset?: number; cursor?: string; includeRole?: boolean; projectId?: string; }>; type PasswordResetLink = AuthenticatedRequest<{ id: string; }, {}, {}, {}>; } export declare namespace MFA { type Verify = AuthenticatedRequest<{}, {}, { mfaCode: string; }, {}>; type Activate = AuthenticatedRequest<{}, {}, { mfaCode: string; }, {}>; type Disable = AuthenticatedRequest<{}, {}, { mfaCode?: string; mfaRecoveryCode?: string; }, {}>; type Config = AuthenticatedRequest<{}, {}, { login: { enabled: boolean; }; }, {}>; type ValidateRecoveryCode = AuthenticatedRequest<{}, {}, { recoveryCode: { enabled: boolean; }; }, {}>; } export declare namespace OAuthRequest { namespace OAuth1Credential { type Auth = AuthenticatedRequest<{}, {}, {}, { id: string; }>; type Callback = AuthenticatedRequest<{}, {}, {}, { oauth_verifier: string; oauth_token: string; state: string; }> & { user?: User; }; } namespace OAuth2Credential { type Auth = AuthenticatedRequest<{}, {}, {}, { id: string; }>; type Callback = AuthenticatedRequest<{}, {}, {}, { code: string; state: string; }>; } } export declare namespace AnnotationTagsRequest { type GetAll = AuthenticatedRequest<{}, {}, {}, { withUsageCount: string; }>; type Create = AuthenticatedRequest<{}, {}, { name: string; }>; type Update = AuthenticatedRequest<{ id: string; }, {}, { name: string; }>; type Delete = AuthenticatedRequest<{ id: string; }>; } export declare namespace NodeRequest { type GetAll = AuthenticatedRequest; type Post = AuthenticatedRequest<{}, {}, { name?: string; verify?: boolean; version?: string; }>; type Delete = AuthenticatedRequest<{}, {}, {}, { name: string; }>; type Update = Post; } export declare namespace LicenseRequest { type Activate = AuthenticatedRequest<{}, {}, { activationKey: string; }, {}>; } export declare namespace VariablesRequest { type CreateUpdatePayload = Omit & { id?: unknown; }; type GetAll = AuthenticatedRequest; type Get = AuthenticatedRequest<{ id: string; }, {}, {}, {}>; type Create = AuthenticatedRequest<{}, {}, CreateUpdatePayload, {}>; type Update = AuthenticatedRequest<{ id: string; }, {}, CreateUpdatePayload, {}>; type Delete = Get; } export declare namespace WorkflowHistoryRequest { type GetList = AuthenticatedRequest<{ workflowId: string; }, Array>, {}, ListQuery.Options>; type GetVersion = AuthenticatedRequest<{ workflowId: string; versionId: string; }, WorkflowHistory>; } export declare namespace ActiveWorkflowRequest { type GetAllActive = AuthenticatedRequest; type GetActivationError = AuthenticatedRequest<{ id: string; }>; } export declare namespace ProjectRequest { type GetMyProjectsResponse = Array; type ProjectRelationResponse = { id: string; email: string; firstName: string; lastName: string; role: ProjectRole; }; type ProjectWithRelations = { id: string; name: string | undefined; icon: ProjectIcon | null; type: ProjectType; description: string | null; relations: ProjectRelationResponse[]; scopes: Scope[]; }; } export declare namespace NpsSurveyRequest { type NpsSurveyUpdate = AuthenticatedRequest<{}, {}, unknown>; }