@shopify/cli-kit/dist/public/node/api/functions.d.ts

A set of utilities, interfaces, and models that are common across all the platform features

import { UnauthorizedHandler } from './graphql.js';
import { TypedDocumentNode } from '@graphql-typed-document-node/core';
import { Variables } from 'graphql-request';
/**
 * @param orgId - Organization identifier.
 * @param query - Typed GraphQL document node.
 * @param token - Authentication token.
 * @param appId - App identifier.
 * @param variables - Optional query variables.
 * @param unauthorizedHandler - Optional handler for unauthorized requests.
 */
export interface FunctionsRequestOptions<TResult, TVariables extends Variables> {
    organizationId: string;
    query: TypedDocumentNode<TResult, TVariables>;
    token: string;
    appId: string;
    unauthorizedHandler: UnauthorizedHandler;
    variables?: TVariables;
}
/**
 * Executes a rate-limited GraphQL request against the App Management Functions API.
 *
 * @param options - Request options.
 * @returns Promise resolving to the typed query result.
 */
export declare function functionsRequestDoc<TResult, TVariables extends Variables>(options: FunctionsRequestOptions<TResult, TVariables>): Promise<TResult>;