cloudflare/src/resources/acm/total-tls.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 BaseTotalTLS extends APIResource {
  static override readonly _key: readonly ['acm', 'totalTLS'] = Object.freeze(['acm', 'totalTLS'] as const);

  /**
   * Set Total TLS Settings or disable the feature for a Zone.
   *
   * @example
   * ```ts
   * const totalTLS = await client.acm.totalTLS.update({
   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *   enabled: true,
   * });
   * ```
   */
  update(params: TotalTLSUpdateParams, options?: RequestOptions): APIPromise<TotalTLSUpdateResponse> {
    const { zone_id, ...body } = params;
    return (
      this._client.post(path`/zones/${zone_id}/acm/total_tls`, { body, ...options }) as APIPromise<{
        result: TotalTLSUpdateResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Set Total TLS Settings or disable the feature for a Zone.
   *
   * @example
   * ```ts
   * const response = await client.acm.totalTLS.edit({
   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *   enabled: true,
   * });
   * ```
   */
  edit(params: TotalTLSEditParams, options?: RequestOptions): APIPromise<TotalTLSEditResponse> {
    const { zone_id, ...body } = params;
    return (
      this._client.post(path`/zones/${zone_id}/acm/total_tls`, { body, ...options }) as APIPromise<{
        result: TotalTLSEditResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Get Total TLS Settings for a Zone.
   *
   * @example
   * ```ts
   * const totalTLS = await client.acm.totalTLS.get({
   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   * });
   * ```
   */
  get(params: TotalTLSGetParams, options?: RequestOptions): APIPromise<TotalTLSGetResponse> {
    const { zone_id } = params;
    return (
      this._client.get(path`/zones/${zone_id}/acm/total_tls`, options) as APIPromise<{
        result: TotalTLSGetResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class TotalTLS extends BaseTotalTLS {}

/**
 * The Certificate Authority that Total TLS certificates will be issued through.
 */
export type CertificateAuthority = 'google' | 'lets_encrypt' | 'ssl_com';

/**
 * The Certificate Authority that Total TLS certificates will be issued through.
 */
export type CertificateAuthorityParam = 'google' | 'lets_encrypt' | 'ssl_com';

export interface TotalTLSUpdateResponse {
  /**
   * The Certificate Authority that Total TLS certificates will be issued through.
   */
  certificate_authority?: CertificateAuthority;

  /**
   * If enabled, Total TLS will order a hostname specific TLS certificate for any
   * proxied A, AAAA, or CNAME record in your zone.
   */
  enabled?: boolean;

  /**
   * The validity period in days for the certificates ordered via Total TLS.
   */
  validity_period?: 90;
}

export interface TotalTLSEditResponse {
  /**
   * The Certificate Authority that Total TLS certificates will be issued through.
   */
  certificate_authority?: CertificateAuthority;

  /**
   * If enabled, Total TLS will order a hostname specific TLS certificate for any
   * proxied A, AAAA, or CNAME record in your zone.
   */
  enabled?: boolean;

  /**
   * The validity period in days for the certificates ordered via Total TLS.
   */
  validity_period?: 90;
}

export interface TotalTLSGetResponse {
  /**
   * The Certificate Authority that Total TLS certificates will be issued through.
   */
  certificate_authority?: CertificateAuthority;

  /**
   * If enabled, Total TLS will order a hostname specific TLS certificate for any
   * proxied A, AAAA, or CNAME record in your zone.
   */
  enabled?: boolean;

  /**
   * The validity period in days for the certificates ordered via Total TLS.
   */
  validity_period?: 90;
}

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

  /**
   * Body param: If enabled, Total TLS will order a hostname specific TLS certificate
   * for any proxied A, AAAA, or CNAME record in your zone.
   */
  enabled: boolean;

  /**
   * Body param: The Certificate Authority that Total TLS certificates will be issued
   * through.
   */
  certificate_authority?: CertificateAuthorityParam;
}

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

  /**
   * Body param: If enabled, Total TLS will order a hostname specific TLS certificate
   * for any proxied A, AAAA, or CNAME record in your zone.
   */
  enabled: boolean;

  /**
   * Body param: The Certificate Authority that Total TLS certificates will be issued
   * through.
   */
  certificate_authority?: CertificateAuthorityParam;
}

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

export declare namespace TotalTLS {
  export {
    type CertificateAuthority as CertificateAuthority,
    type TotalTLSUpdateResponse as TotalTLSUpdateResponse,
    type TotalTLSEditResponse as TotalTLSEditResponse,
    type TotalTLSGetResponse as TotalTLSGetResponse,
    type TotalTLSUpdateParams as TotalTLSUpdateParams,
    type TotalTLSEditParams as TotalTLSEditParams,
    type TotalTLSGetParams as TotalTLSGetParams,
  };
}