cloudflare/src/resources/healthchecks/previews.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 * as HealthchecksAPI from './healthchecks';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class BasePreviews extends APIResource {
  static override readonly _key: readonly ['healthchecks', 'previews'] = Object.freeze([
    'healthchecks',
    'previews',
  ] as const);

  /**
   * Create a new preview health check.
   *
   * @example
   * ```ts
   * const healthcheck =
   *   await client.healthchecks.previews.create({
   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *     address: 'www.example.com',
   *     name: 'server-1',
   *   });
   * ```
   */
  create(params: PreviewCreateParams, options?: RequestOptions): APIPromise<HealthchecksAPI.Healthcheck> {
    const { zone_id, ...body } = params;
    return (
      this._client.post(path`/zones/${zone_id}/healthchecks/preview`, { body, ...options }) as APIPromise<{
        result: HealthchecksAPI.Healthcheck;
      }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Delete a health check.
   *
   * @example
   * ```ts
   * const preview = await client.healthchecks.previews.delete(
   *   '023e105f4ecef8ad9ca31a8372d0c353',
   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * );
   * ```
   */
  delete(
    healthcheckID: string,
    params: PreviewDeleteParams,
    options?: RequestOptions,
  ): APIPromise<PreviewDeleteResponse> {
    const { zone_id } = params;
    return (
      this._client.delete(
        path`/zones/${zone_id}/healthchecks/preview/${healthcheckID}`,
        options,
      ) as APIPromise<{ result: PreviewDeleteResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Fetch a single configured health check preview.
   *
   * @example
   * ```ts
   * const healthcheck = await client.healthchecks.previews.get(
   *   '023e105f4ecef8ad9ca31a8372d0c353',
   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * );
   * ```
   */
  get(
    healthcheckID: string,
    params: PreviewGetParams,
    options?: RequestOptions,
  ): APIPromise<HealthchecksAPI.Healthcheck> {
    const { zone_id } = params;
    return (
      this._client.get(path`/zones/${zone_id}/healthchecks/preview/${healthcheckID}`, options) as APIPromise<{
        result: HealthchecksAPI.Healthcheck;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Previews extends BasePreviews {}

export interface PreviewDeleteResponse {
  /**
   * Identifier
   */
  id?: string;
}

export interface PreviewCreateParams {
  /**
   * Path param: Identifier
   */
  zone_id: string;

  /**
   * Body param: The hostname or IP address of the origin server to run health checks
   * on.
   */
  address: string;

  /**
   * Body param: A short name to identify the health check. Only alphanumeric
   * characters, hyphens and underscores are allowed.
   */
  name: string;

  /**
   * Body param: A list of regions from which to run health checks. Null means
   * Cloudflare will pick a default region.
   */
  check_regions?: Array<HealthchecksAPI.CheckRegionParam> | null;

  /**
   * Body param: The number of consecutive fails required from a health check before
   * changing the health to unhealthy.
   */
  consecutive_fails?: number;

  /**
   * Body param: The number of consecutive successes required from a health check
   * before changing the health to healthy.
   */
  consecutive_successes?: number;

  /**
   * Body param: A human-readable description of the health check.
   */
  description?: string;

  /**
   * Body param: Parameters specific to an HTTP or HTTPS health check.
   */
  http_config?: HealthchecksAPI.HTTPConfigurationParam | null;

  /**
   * Body param: The interval between each health check. Shorter intervals may give
   * quicker notifications if the origin status changes, but will increase load on
   * the origin as we check from multiple locations.
   */
  interval?: number;

  /**
   * Body param: The number of retries to attempt in case of a timeout before marking
   * the origin as unhealthy. Retries are attempted immediately.
   */
  retries?: number;

  /**
   * Body param: If suspended, no health checks are sent to the origin.
   */
  suspended?: boolean;

  /**
   * Body param: Parameters specific to TCP health check.
   */
  tcp_config?: HealthchecksAPI.TCPConfigurationParam | null;

  /**
   * Body param: The timeout (in seconds) before marking the health check as failed.
   */
  timeout?: number;

  /**
   * Body param: The protocol to use for the health check. Currently supported
   * protocols are 'HTTP', 'HTTPS' and 'TCP'.
   */
  type?: string;
}

export interface PreviewDeleteParams {
  /**
   * Identifier
   */
  zone_id: string;
}

export interface PreviewGetParams {
  /**
   * Identifier
   */
  zone_id: string;
}

export declare namespace Previews {
  export {
    type PreviewDeleteResponse as PreviewDeleteResponse,
    type PreviewCreateParams as PreviewCreateParams,
    type PreviewDeleteParams as PreviewDeleteParams,
    type PreviewGetParams as PreviewGetParams,
  };
}