cloudflare/src/resources/dns/zone-transfers/force-axfr.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 BaseForceAXFRResource extends APIResource {
  static override readonly _key: readonly ['dns', 'zoneTransfers', 'forceAXFR'] = Object.freeze([
    'dns',
    'zoneTransfers',
    'forceAXFR',
  ] as const);

  /**
   * Sends AXFR zone transfer request to primary nameserver(s).
   *
   * @example
   * ```ts
   * const forceAXFR =
   *   await client.dns.zoneTransfers.forceAXFR.create({
   *     zone_id: '269d8f4853475ca241c4e730be286b20',
   *   });
   * ```
   */
  create(params: ForceAXFRCreateParams, options?: RequestOptions): APIPromise<ForceAXFR> {
    const { zone_id } = params;
    return (
      this._client.post(path`/zones/${zone_id}/secondary_dns/force_axfr`, options) as APIPromise<{
        result: ForceAXFR;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class ForceAXFRResource extends BaseForceAXFRResource {}

/**
 * When force_axfr query parameter is set to true, the response is a simple string.
 */
export type ForceAXFR = string;

export interface ForceAXFRCreateParams {
  zone_id: string;
}

export declare namespace ForceAXFRResource {
  export { type ForceAXFR as ForceAXFR, type ForceAXFRCreateParams as ForceAXFRCreateParams };
}