cloudflare/resources/google-tag-gateway/config.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseConfigResource extends APIResource {
    static readonly _key: readonly ['googleTagGateway', 'config'];
    /**
     * Updates the Google Tag Gateway configuration for a zone.
     *
     * @example
     * ```ts
     * const config = await client.googleTagGateway.config.update({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   enabled: true,
     *   endpoint: '/metrics',
     *   hideOriginalIp: true,
     *   measurementId: 'GTM-P2F3N47Q',
     * });
     * ```
     */
    update(params: ConfigUpdateParams, options?: RequestOptions): APIPromise<Config>;
    /**
     * Gets the Google Tag Gateway configuration for a zone.
     *
     * @example
     * ```ts
     * const config = await client.googleTagGateway.config.get({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    get(params: ConfigGetParams, options?: RequestOptions): APIPromise<Config>;
}
export declare class ConfigResource extends BaseConfigResource {
}
/**
 * Google Tag Gateway configuration for a zone.
 */
export interface Config {
    /**
     * Enables or disables Google Tag Gateway for this zone.
     */
    enabled: boolean;
    /**
     * Specifies the endpoint path for proxying Google Tag Manager requests. Use an
     * absolute path starting with '/', with no nested paths and alphanumeric
     * characters only (e.g. /metrics).
     */
    endpoint: string;
    /**
     * Hides the original client IP address from Google when enabled.
     */
    hideOriginalIp: boolean;
    /**
     * Specify the Google Tag Manager container or measurement ID (e.g. GTM-XXXXXXX or
     * G-XXXXXXXXXX).
     */
    measurementId: string;
    /**
     * Set up the associated Google Tag on the zone automatically when enabled.
     */
    setUpTag?: boolean | null;
}
export interface ConfigUpdateParams {
    /**
     * Path param: Identifier.
     */
    zone_id: string;
    /**
     * Body param: Enables or disables Google Tag Gateway for this zone.
     */
    enabled: boolean;
    /**
     * Body param: Specifies the endpoint path for proxying Google Tag Manager
     * requests. Use an absolute path starting with '/', with no nested paths and
     * alphanumeric characters only (e.g. /metrics).
     */
    endpoint: string;
    /**
     * Body param: Hides the original client IP address from Google when enabled.
     */
    hideOriginalIp: boolean;
    /**
     * Body param: Specify the Google Tag Manager container or measurement ID (e.g.
     * GTM-XXXXXXX or G-XXXXXXXXXX).
     */
    measurementId: string;
    /**
     * Body param: Set up the associated Google Tag on the zone automatically when
     * enabled.
     */
    setUpTag?: boolean | null;
}
export interface ConfigGetParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace ConfigResource {
    export { type Config as Config, type ConfigUpdateParams as ConfigUpdateParams, type ConfigGetParams as ConfigGetParams, };
}
//# sourceMappingURL=config.d.ts.map