@dmgt/google-ad-manager-api/dist/query/query.d.ts

Typed Google Ad Manager API

import { Client } from 'soap';
import { PQLOptions } from './pql';
import { GetByStatement, GetByStatementResponseResult } from './statement';
import { Value, ValueKey } from './value';
/**
 * Query a service wth PQL options.
 *
 * If a client's method matches that of a usual query statement,
 * using this function will infer the query object.
 *
 * @deprecated Use {@link function:getByStatement}
 *
 * @example
 * ```
 * query(client, 'getLineItemsByStatementAsync', {
 *   where: {
 *     id: 123
 *   }
 * })
 * ```
 * Is syntactical sugar for:
 * ```
 * client.getLineItemsByStatementAsync({
 *   filterStatement: {
 *     query: pql<LineItems>({
 *       where: {
 *         id: 123
 *       }
 *     })
 *   }
 * })
 * ```
 */
export declare function query<C extends Client, M extends keyof C, V extends Value<string> = Value<never>, Args extends unknown[] = []>(client: C, methodName: Parameters<C[M]> extends [GetByStatement, ...unknown[]] ? M : never, query: PQLOptions<GetByStatementResponseResult<C[M]>, ValueKey<V>>, values?: V[], ...args: Args): ReturnType<C[M]>;