cloudflare/src/resources/acm/custom-trust-store.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 { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../core/pagination';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class BaseCustomTrustStore extends APIResource {
  static override readonly _key: readonly ['acm', 'customTrustStore'] = Object.freeze([
    'acm',
    'customTrustStore',
  ] as const);

  /**
   * Upload a root CA certificate to the Custom Origin Trust Store for a Zone. Only
   * root CA certificates are accepted.
   *
   * @example
   * ```ts
   * const customTrustStore =
   *   await client.acm.customTrustStore.create({
   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *     certificate:
   *       '-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n',
   *   });
   * ```
   */
  create(params: CustomTrustStoreCreateParams, options?: RequestOptions): APIPromise<CustomTrustStore> {
    const { zone_id, ...body } = params;
    return (
      this._client.post(path`/zones/${zone_id}/acm/custom_trust_store`, { body, ...options }) as APIPromise<{
        result: CustomTrustStore;
      }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Get Custom Origin Trust Store for a Zone.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const customTrustStore of client.acm.customTrustStore.list(
   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * )) {
   *   // ...
   * }
   * ```
   */
  list(
    params: CustomTrustStoreListParams,
    options?: RequestOptions,
  ): PagePromise<CustomTrustStoresV4PagePaginationArray, CustomTrustStore> {
    const { zone_id, ...query } = params;
    return this._client.getAPIList(
      path`/zones/${zone_id}/acm/custom_trust_store`,
      V4PagePaginationArray<CustomTrustStore>,
      { query, ...options },
    );
  }

  /**
   * Removes a root CA certificate from the custom origin trust store. Origins using
   * certificates signed by this CA will no longer be trusted.
   *
   * @example
   * ```ts
   * const customTrustStore =
   *   await client.acm.customTrustStore.delete(
   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  delete(
    customOriginTrustStoreID: string,
    params: CustomTrustStoreDeleteParams,
    options?: RequestOptions,
  ): APIPromise<CustomTrustStoreDeleteResponse> {
    const { zone_id } = params;
    return (
      this._client.delete(
        path`/zones/${zone_id}/acm/custom_trust_store/${customOriginTrustStoreID}`,
        options,
      ) as APIPromise<{ result: CustomTrustStoreDeleteResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Retrieves details about a specific root CA certificate in the custom origin
   * trust store, including expiration and subject information.
   *
   * @example
   * ```ts
   * const customTrustStore =
   *   await client.acm.customTrustStore.get(
   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  get(
    customOriginTrustStoreID: string,
    params: CustomTrustStoreGetParams,
    options?: RequestOptions,
  ): APIPromise<CustomTrustStore> {
    const { zone_id } = params;
    return (
      this._client.get(
        path`/zones/${zone_id}/acm/custom_trust_store/${customOriginTrustStoreID}`,
        options,
      ) as APIPromise<{ result: CustomTrustStore }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class CustomTrustStore extends BaseCustomTrustStore {}

export type CustomTrustStoresV4PagePaginationArray = V4PagePaginationArray<CustomTrustStore>;

export interface CustomTrustStore {
  /**
   * Certificate identifier tag.
   */
  id: string;

  /**
   * The root CA certificate in PEM format. Only root CA certificates are accepted;
   * intermediate and leaf certificates are not supported.
   */
  certificate: string;

  /**
   * When the certificate expires.
   */
  expires_on: string;

  /**
   * The certificate authority that issued the certificate.
   */
  issuer: string;

  /**
   * The type of hash used for the certificate.
   */
  signature: string;

  /**
   * Status of the zone's custom SSL.
   */
  status: 'initializing' | 'pending_deployment' | 'active' | 'pending_deletion' | 'deleted' | 'expired';

  /**
   * When the certificate was last modified.
   */
  updated_at: string;

  /**
   * When the certificate was uploaded to Cloudflare.
   */
  uploaded_on: string;
}

export interface CustomTrustStoreDeleteResponse {
  /**
   * Certificate identifier tag.
   */
  id?: string;
}

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

  /**
   * Body param: The root CA certificate in PEM format. Only root CA certificates are
   * accepted; intermediate and leaf certificates are not supported.
   */
  certificate: string;
}

export interface CustomTrustStoreListParams extends V4PagePaginationArrayParams {
  /**
   * Path param: Identifier.
   */
  zone_id: string;

  /**
   * Query param: Limit to the number of records returned.
   */
  limit?: number;

  /**
   * Query param: Offset the results.
   */
  offset?: number;
}

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

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

export declare namespace CustomTrustStore {
  export {
    type CustomTrustStore as CustomTrustStore,
    type CustomTrustStoreDeleteResponse as CustomTrustStoreDeleteResponse,
    type CustomTrustStoresV4PagePaginationArray as CustomTrustStoresV4PagePaginationArray,
    type CustomTrustStoreCreateParams as CustomTrustStoreCreateParams,
    type CustomTrustStoreListParams as CustomTrustStoreListParams,
    type CustomTrustStoreDeleteParams as CustomTrustStoreDeleteParams,
    type CustomTrustStoreGetParams as CustomTrustStoreGetParams,
  };
}