cloudflare/src/resources/zero-trust/devices/resilience/global-warp-override.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 BaseGlobalWARPOverride extends APIResource {
  static override readonly _key: readonly ['zeroTrust', 'devices', 'resilience', 'globalWARPOverride'] =
    Object.freeze(['zeroTrust', 'devices', 'resilience', 'globalWARPOverride'] as const);

  /**
   * Sets the Global WARP disconnect state.
   *
   * @example
   * ```ts
   * const globalWARPOverride =
   *   await client.zeroTrust.devices.resilience.globalWARPOverride.create(
   *     {
   *       account_id: '699d98642c564d2e855e9661899b7252',
   *       disconnect: false,
   *     },
   *   );
   * ```
   */
  create(
    params: GlobalWARPOverrideCreateParams,
    options?: RequestOptions,
  ): APIPromise<GlobalWARPOverrideCreateResponse | null> {
    const { account_id, ...body } = params;
    return (
      this._client.post(path`/accounts/${account_id}/devices/resilience/disconnect`, {
        body,
        ...options,
      }) as APIPromise<{ result: GlobalWARPOverrideCreateResponse | null }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Fetch the Global WARP disconnect state.
   *
   * @example
   * ```ts
   * const globalWARPOverride =
   *   await client.zeroTrust.devices.resilience.globalWARPOverride.get(
   *     { account_id: '699d98642c564d2e855e9661899b7252' },
   *   );
   * ```
   */
  get(
    params: GlobalWARPOverrideGetParams,
    options?: RequestOptions,
  ): APIPromise<GlobalWARPOverrideGetResponse | null> {
    const { account_id } = params;
    return (
      this._client.get(path`/accounts/${account_id}/devices/resilience/disconnect`, options) as APIPromise<{
        result: GlobalWARPOverrideGetResponse | null;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class GlobalWARPOverride extends BaseGlobalWARPOverride {}

export interface GlobalWARPOverrideCreateResponse {
  /**
   * Disconnects all devices on the account using Global WARP override.
   */
  disconnect?: boolean;

  /**
   * When the Global WARP override state was updated.
   */
  timestamp?: string;
}

export interface GlobalWARPOverrideGetResponse {
  /**
   * Disconnects all devices on the account using Global WARP override.
   */
  disconnect?: boolean;

  /**
   * When the Global WARP override state was updated.
   */
  timestamp?: string;
}

export interface GlobalWARPOverrideCreateParams {
  /**
   * Path param
   */
  account_id: string;

  /**
   * Body param: Disconnects all devices on the account using Global WARP override.
   */
  disconnect: boolean;

  /**
   * Body param: Reasoning for setting the Global WARP override state. This will be
   * surfaced in the audit log.
   */
  justification?: string;
}

export interface GlobalWARPOverrideGetParams {
  account_id: string;
}

export declare namespace GlobalWARPOverride {
  export {
    type GlobalWARPOverrideCreateResponse as GlobalWARPOverrideCreateResponse,
    type GlobalWARPOverrideGetResponse as GlobalWARPOverrideGetResponse,
    type GlobalWARPOverrideCreateParams as GlobalWARPOverrideCreateParams,
    type GlobalWARPOverrideGetParams as GlobalWARPOverrideGetParams,
  };
}