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

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class BaseConfigResource extends APIResource {
  static override readonly _key: readonly ['googleTagGateway', 'config'] = Object.freeze([
    'googleTagGateway',
    'config',
  ] as const);

  /**
   * 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> {
    const { zone_id, ...body } = params;
    return (
      this._client.put(path`/zones/${zone_id}/settings/google-tag-gateway/config`, {
        body,
        ...options,
      }) as APIPromise<{ result: Config }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * 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> {
    const { zone_id } = params;
    return (
      this._client.get(path`/zones/${zone_id}/settings/google-tag-gateway/config`, options) as APIPromise<{
        result: Config;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export 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,
  };
}