cloudflare/src/resources/diagnostics/endpoint-healthchecks.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 '../../resource';
import * as Core from '../../core';

export class EndpointHealthchecks extends APIResource {
  /**
   * Create Endpoint Health Check.
   *
   * @example
   * ```ts
   * const endpointHealthcheck =
   *   await client.diagnostics.endpointHealthchecks.create({
   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *     check_type: 'icmp',
   *     endpoint: '203.0.113.1',
   *   });
   * ```
   */
  create(
    params: EndpointHealthcheckCreateParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<EndpointHealthcheckCreateResponse> {
    const { account_id, ...body } = params;
    return (
      this._client.post(`/accounts/${account_id}/diagnostics/endpoint-healthchecks`, {
        body,
        ...options,
      }) as Core.APIPromise<{ result: EndpointHealthcheckCreateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Update a Endpoint Health Check.
   *
   * @example
   * ```ts
   * const endpointHealthcheck =
   *   await client.diagnostics.endpointHealthchecks.update(
   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
   *     {
   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *       check_type: 'icmp',
   *       endpoint: '203.0.113.1',
   *     },
   *   );
   * ```
   */
  update(
    id: string,
    params: EndpointHealthcheckUpdateParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<EndpointHealthcheckUpdateResponse> {
    const { account_id, ...body } = params;
    return (
      this._client.put(`/accounts/${account_id}/diagnostics/endpoint-healthchecks/${id}`, {
        body,
        ...options,
      }) as Core.APIPromise<{ result: EndpointHealthcheckUpdateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * List Endpoint Health Checks.
   *
   * @example
   * ```ts
   * const endpointHealthchecks =
   *   await client.diagnostics.endpointHealthchecks.list({
   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *   });
   * ```
   */
  list(
    params: EndpointHealthcheckListParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<EndpointHealthcheckListResponse> {
    const { account_id } = params;
    return (
      this._client.get(
        `/accounts/${account_id}/diagnostics/endpoint-healthchecks`,
        options,
      ) as Core.APIPromise<{ result: EndpointHealthcheckListResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Delete Endpoint Health Check.
   *
   * @example
   * ```ts
   * const endpointHealthcheck =
   *   await client.diagnostics.endpointHealthchecks.delete(
   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  delete(
    id: string,
    params: EndpointHealthcheckDeleteParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<EndpointHealthcheckDeleteResponse> {
    const { account_id } = params;
    return this._client.delete(`/accounts/${account_id}/diagnostics/endpoint-healthchecks/${id}`, options);
  }

  /**
   * Get a single Endpoint Health Check.
   *
   * @example
   * ```ts
   * const endpointHealthcheck =
   *   await client.diagnostics.endpointHealthchecks.get(
   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  get(
    id: string,
    params: EndpointHealthcheckGetParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<EndpointHealthcheckGetResponse> {
    const { account_id } = params;
    return (
      this._client.get(
        `/accounts/${account_id}/diagnostics/endpoint-healthchecks/${id}`,
        options,
      ) as Core.APIPromise<{ result: EndpointHealthcheckGetResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}

export interface EndpointHealthcheck {
  /**
   * type of check to perform
   */
  check_type: 'icmp';

  /**
   * the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckCreateResponse {
  /**
   * type of check to perform
   */
  check_type: 'icmp';

  /**
   * the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * UUID.
   */
  id?: string;

  /**
   * Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckUpdateResponse {
  /**
   * type of check to perform
   */
  check_type: 'icmp';

  /**
   * the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * UUID.
   */
  id?: string;

  /**
   * Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckListResponse {
  /**
   * type of check to perform
   */
  check_type: 'icmp';

  /**
   * the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * UUID.
   */
  id?: string;

  /**
   * Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckDeleteResponse {
  errors: Array<EndpointHealthcheckDeleteResponse.Error>;

  messages: Array<EndpointHealthcheckDeleteResponse.Message>;

  /**
   * Whether the API call was successful.
   */
  success: true;
}

export namespace EndpointHealthcheckDeleteResponse {
  export interface Error {
    code: number;

    message: string;

    documentation_url?: string;

    source?: Error.Source;
  }

  export namespace Error {
    export interface Source {
      pointer?: string;
    }
  }

  export interface Message {
    code: number;

    message: string;

    documentation_url?: string;

    source?: Message.Source;
  }

  export namespace Message {
    export interface Source {
      pointer?: string;
    }
  }
}

export interface EndpointHealthcheckGetResponse {
  /**
   * type of check to perform
   */
  check_type: 'icmp';

  /**
   * the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * UUID.
   */
  id?: string;

  /**
   * Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckCreateParams {
  /**
   * Path param: Identifier
   */
  account_id: string;

  /**
   * Body param: type of check to perform
   */
  check_type: 'icmp';

  /**
   * Body param: the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * Body param: Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckUpdateParams {
  /**
   * Path param: Identifier
   */
  account_id: string;

  /**
   * Body param: type of check to perform
   */
  check_type: 'icmp';

  /**
   * Body param: the IP address of the host to perform checks against
   */
  endpoint: string;

  /**
   * Body param: Optional name associated with this check
   */
  name?: string;
}

export interface EndpointHealthcheckListParams {
  /**
   * Identifier
   */
  account_id: string;
}

export interface EndpointHealthcheckDeleteParams {
  /**
   * Identifier
   */
  account_id: string;
}

export interface EndpointHealthcheckGetParams {
  /**
   * Identifier
   */
  account_id: string;
}

export declare namespace EndpointHealthchecks {
  export {
    type EndpointHealthcheck as EndpointHealthcheck,
    type EndpointHealthcheckCreateResponse as EndpointHealthcheckCreateResponse,
    type EndpointHealthcheckUpdateResponse as EndpointHealthcheckUpdateResponse,
    type EndpointHealthcheckListResponse as EndpointHealthcheckListResponse,
    type EndpointHealthcheckDeleteResponse as EndpointHealthcheckDeleteResponse,
    type EndpointHealthcheckGetResponse as EndpointHealthcheckGetResponse,
    type EndpointHealthcheckCreateParams as EndpointHealthcheckCreateParams,
    type EndpointHealthcheckUpdateParams as EndpointHealthcheckUpdateParams,
    type EndpointHealthcheckListParams as EndpointHealthcheckListParams,
    type EndpointHealthcheckDeleteParams as EndpointHealthcheckDeleteParams,
    type EndpointHealthcheckGetParams as EndpointHealthcheckGetParams,
  };
}