/** @module Predefined Requests */ import { FetchResponse, UserProvidedPredefinedRequest } from '@qualtrics-app-framework/plugin-manager/src/models'; import PluginClient from '@qualtrics/plugin-client'; /** * Mapping of predefined request names to their parameter override configuration. * Key-value pair where the key is a predefined request name and the value is map of parameter name and override value. */ export declare type RequestParamOverrides = Record; /** * Mapping of predefined request names to their parameter override configuration. * Key-value pair where the key is a parameter name and the value the override value. */ export declare type RequestParamOverrideConfig = Record; /** * Predefined Request parameter functions */ export interface PredefinedRequestBuilder { /** * Set the parameter overrides for a single predefined request * * @param requestName - the name of the predefined request * @param overrides - object containing key-value pairs of parameter name and override value */ setRequestParamOverrides(requestName: string, overrides: Record): Promise; /** * Set the parameter override for a single argument on a single predefined request. * * @param requestName - the name of the predefined request * @param parameterName - the argument name of the predefined request * @param overrideValue - the overridden value of the request's argument */ setRequestParamOverride(requestName: string, parameterName: string, overrideValue: string): Promise; /** * Unsets the parameter override for a single argument on a single predefined request. * * @param requestName - the name of the predefined request * @param parameterName - the argument name of the predefined request */ unsetRequestParamOverride(requestName: string, parameterName: string): Promise; } /** * The function signature for invoking predefined requests. */ export type InvokePredefinedRequest = PluginClient['invokePredefinedRequest']; export { FetchResponse, UserProvidedPredefinedRequest, }; /** * The interface for an object which handles predefined requests. */ export interface PredefinedRequestHandler { invokePredefinedRequest: InvokePredefinedRequest; } //# sourceMappingURL=predefined-request.d.ts.map