cloudflare/src/resources/logs/received/fields.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 BaseFields extends APIResource {
  static override readonly _key: readonly ['logs', 'received', 'fields'] = Object.freeze([
    'logs',
    'received',
    'fields',
  ] as const);

  /**
   * Lists all fields available. The response is json object with key-value pairs,
   * where keys are field names, and values are descriptions.
   *
   * @example
   * ```ts
   * const field = await client.logs.received.fields.get({
   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   * });
   * ```
   */
  get(params: FieldGetParams, options?: RequestOptions): APIPromise<FieldGetResponse> {
    const { zone_id } = params;
    return this._client.get(path`/zones/${zone_id}/logs/received/fields`, options);
  }
}
export class Fields extends BaseFields {}

export interface FieldGetResponse {
  key?: string;
}

export interface FieldGetParams {
  /**
   * Identifier.
   */
  zone_id: string;
}

export declare namespace Fields {
  export { type FieldGetResponse as FieldGetResponse, type FieldGetParams as FieldGetParams };
}