n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/graphql/v1.ts

Base nodes of n8n

/**
 * GraphQL Node - Version 1
 * Makes a GraphQL request and returns the received data
 */


export interface GraphqlV1Params {
/**
 * The way to authenticate
 * @default none
 */
    authentication?: 'basicAuth' | 'customAuth' | 'digestAuth' | 'headerAuth' | 'none' | 'oAuth1' | 'oAuth2' | 'queryAuth' | Expression<string>;
/**
 * The underlying HTTP request method to use
 * @default POST
 */
    requestMethod?: 'GET' | 'POST' | Expression<string>;
/**
 * The GraphQL endpoint
 */
    endpoint?: string | Expression<string> | PlaceholderValue;
/**
 * Whether to download the response even if SSL certificate validation is not possible
 * @default false
 */
    allowUnauthorizedCerts?: boolean | Expression<boolean>;
/**
 * The format for the query payload
 * @displayOptions.show { requestMethod: ["POST"] }
 * @default graphql
 */
    requestFormat?: 'graphql' | 'json' | Expression<string>;
/**
 * GraphQL query
 */
    query?: string | Expression<string> | PlaceholderValue;
/**
 * Query variables as JSON object
 * @displayOptions.show { requestFormat: ["json"], requestMethod: ["POST"] }
 */
    variables?: IDataObject | string | Expression<string>;
/**
 * Name of operation to execute
 * @displayOptions.show { requestFormat: ["json"], requestMethod: ["POST"] }
 */
    operationName?: string | Expression<string> | PlaceholderValue;
/**
 * The format in which the data gets returned from the URL
 * @default json
 */
    responseFormat?: 'json' | 'string' | Expression<string>;
/**
 * Name of the property to which to write the response data
 * @displayOptions.show { responseFormat: ["string"] }
 * @default data
 */
    dataPropertyName?: string | Expression<string> | PlaceholderValue;
/**
 * The headers to send
 * @default {}
 */
    headerParametersUi?: {
        /** Header
     */
    parameter?: Array<{
      /** Name of the header
       */
      name?: string | Expression<string> | PlaceholderValue;
      /** Value to set for the header
       */
      value?: string | Expression<string> | PlaceholderValue;
    }>;
  };
}

export interface GraphqlV1Credentials {
  httpBasicAuth: CredentialReference;
  httpCustomAuth: CredentialReference;
  httpDigestAuth: CredentialReference;
  httpHeaderAuth: CredentialReference;
  httpQueryAuth: CredentialReference;
  oAuth1Api: CredentialReference;
  oAuth2Api: CredentialReference;
}

interface GraphqlV1NodeBase {
  type: 'n8n-nodes-base.graphql';
  version: 1;
  credentials?: GraphqlV1Credentials;
}

export type GraphqlV1ParamsNode = GraphqlV1NodeBase & {
  config: NodeConfig<GraphqlV1Params>;
};

export type GraphqlV1Node = GraphqlV1ParamsNode;