cloudflare/src/resources/mtls-certificates/associations.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 { PagePromise, SinglePage } from '../../core/pagination';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class BaseAssociations extends APIResource {
  static override readonly _key: readonly ['mtlsCertificates', 'associations'] = Object.freeze([
    'mtlsCertificates',
    'associations',
  ] as const);

  /**
   * Lists all active associations between the certificate and Cloudflare services.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const certificateAsssociation of client.mtlsCertificates.associations.get(
   *   '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * )) {
   *   // ...
   * }
   * ```
   */
  get(
    mtlsCertificateID: string,
    params: AssociationGetParams,
    options?: RequestOptions,
  ): PagePromise<CertificateAsssociationsSinglePage, CertificateAsssociation> {
    const { account_id } = params;
    return this._client.getAPIList(
      path`/accounts/${account_id}/mtls_certificates/${mtlsCertificateID}/associations`,
      SinglePage<CertificateAsssociation>,
      options,
    );
  }
}
export class Associations extends BaseAssociations {}

export type CertificateAsssociationsSinglePage = SinglePage<CertificateAsssociation>;

export interface CertificateAsssociation {
  /**
   * The service using the certificate.
   */
  service?: string;

  /**
   * Certificate deployment status for the given service.
   */
  status?: string;
}

export interface AssociationGetParams {
  /**
   * Identifier.
   */
  account_id: string;
}

export declare namespace Associations {
  export {
    type CertificateAsssociation as CertificateAsssociation,
    type CertificateAsssociationsSinglePage as CertificateAsssociationsSinglePage,
    type AssociationGetParams as AssociationGetParams,
  };
}