cloudflare 3.5.0 → 4.1.0

package/src/resources/custom-hostnames/custom-hostnames.ts

@@ -5,10 +5,22 @@ import * as Core from '../../core';
 import * as CustomHostnamesAPI from './custom-hostnames';
 import * as Shared from '../shared';
 import * as FallbackOriginAPI from './fallback-origin';
+import {
+  FallbackOrigin,
+  FallbackOriginDeleteParams,
+  FallbackOriginDeleteResponse,
+  FallbackOriginGetParams,
+  FallbackOriginGetResponse,
+  FallbackOriginUpdateParams,
+  FallbackOriginUpdateResponse,
+} from './fallback-origin';
+import * as CertificatePackAPI from './certificate-pack/certificate-pack';
+import { CertificatePack } from './certificate-pack/certificate-pack';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class CustomHostnames extends APIResource {
   fallbackOrigin: FallbackOriginAPI.FallbackOrigin = new FallbackOriginAPI.FallbackOrigin(this._client);
+  certificatePack: CertificatePackAPI.CertificatePack = new CertificatePackAPI.CertificatePack(this._client);
 
   /**
    * Add a new custom hostname and request that an SSL certificate be issued for it.
@@ -17,7 +29,10 @@ export class CustomHostnames extends APIResource {
    * 'email' will send an email to the WHOIS contacts on file for the base domain
    * plus hostmaster, postmaster, webmaster, admin, administrator. If http is used
    * and the domain is not already pointing to the Managed CNAME host, the PATCH
-   * method must be used once it is (to complete validation).
+   * method must be used once it is (to complete validation). Enable bundling of
+   * certificates using the custom_cert_bundle field. The bundling process requires
+   * the following condition One certificate in the bundle must use an RSA, and the
+   * other must use an ECDSA.
    */
   create(
     params: CustomHostnameCreateParams,
@@ -62,7 +77,10 @@ export class CustomHostnames extends APIResource {
    * Modify SSL configuration for a custom hostname. When sent with SSL config that
    * matches existing config, used to indicate that hostname should pass domain
    * control validation (DCV). Can also be used to change validation type, e.g., from
-   * 'http' to 'email'.
+   * 'http' to 'email'. Bundle an existing certificate with another certificate by
+   * using the "custom_cert_bundle" field. The bundling process supports combining
+   * certificates as long as the following condition is met. One certificate must use
+   * the RSA algorithm, and the other must use the ECDSA algorithm.
    */
   edit(
     customHostnameId: string,
@@ -124,9 +142,6 @@ export interface CustomHostname {
    */
   hostname: string;
 
-  /**
-   * SSL properties for the custom hostname.
-   */
   ssl: CustomHostname.SSL;
 
   /**
@@ -135,9 +150,10 @@ export interface CustomHostname {
   created_at?: string;
 
   /**
-   * These are per-hostname (customer) settings.
+   * Unique key/value metadata for this hostname. These are per-hostname (customer)
+   * settings.
    */
-  custom_metadata?: CustomHostname.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -189,13 +205,10 @@ export interface CustomHostname {
   /**
    * These are errors that were encountered while trying to activate a hostname.
    */
-  verification_errors?: Array<unknown>;
+  verification_errors?: Array<string>;
 }
 
 export namespace CustomHostname {
-  /**
-   * SSL properties for the custom hostname.
-   */
   export interface SSL {
     /**
      * Custom hostname SSL identifier tag.
@@ -238,7 +251,7 @@ export namespace CustomHostname {
     /**
      * A list of Hostnames on a custom uploaded certificate.
      */
-    hosts?: Array<unknown>;
+    hosts?: Array<string>;
 
     /**
      * The issuer on a custom uploaded certificate.
@@ -255,9 +268,6 @@ export namespace CustomHostname {
      */
     serial_number?: string;
 
-    /**
-     * SSL specific settings.
-     */
     settings?: SSL.Settings;
 
     /**
@@ -317,9 +327,6 @@ export namespace CustomHostname {
   }
 
   export namespace SSL {
-    /**
-     * SSL specific settings.
-     */
     export interface Settings {
       /**
        * An allowlist of ciphers for TLS termination. These ciphers must be in the
@@ -355,15 +362,12 @@ export namespace CustomHostname {
       message?: string;
     }
 
-    /**
-     * Certificate's required validation record.
-     */
     export interface ValidationRecord {
       /**
        * The set of email addresses that the certificate authority (CA) will use to
        * complete domain validation.
        */
-      emails?: Array<unknown>;
+      emails?: Array<string>;
 
       /**
        * The content that the certificate authority (CA) will expect to find at the
@@ -390,16 +394,6 @@ export namespace CustomHostname {
     }
   }
 
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
-
   /**
    * This is a record which can be placed to activate a hostname.
    */
@@ -471,9 +465,6 @@ export interface CustomHostnameCreateResponse {
    */
   hostname: string;
 
-  /**
-   * SSL properties for the custom hostname.
-   */
   ssl: CustomHostnameCreateResponse.SSL;
 
   /**
@@ -482,9 +473,10 @@ export interface CustomHostnameCreateResponse {
   created_at?: string;
 
   /**
-   * These are per-hostname (customer) settings.
+   * Unique key/value metadata for this hostname. These are per-hostname (customer)
+   * settings.
    */
-  custom_metadata?: CustomHostnameCreateResponse.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -536,13 +528,10 @@ export interface CustomHostnameCreateResponse {
   /**
    * These are errors that were encountered while trying to activate a hostname.
    */
-  verification_errors?: Array<unknown>;
+  verification_errors?: Array<string>;
 }
 
 export namespace CustomHostnameCreateResponse {
-  /**
-   * SSL properties for the custom hostname.
-   */
   export interface SSL {
     /**
      * Custom hostname SSL identifier tag.
@@ -585,7 +574,7 @@ export namespace CustomHostnameCreateResponse {
     /**
      * A list of Hostnames on a custom uploaded certificate.
      */
-    hosts?: Array<unknown>;
+    hosts?: Array<string>;
 
     /**
      * The issuer on a custom uploaded certificate.
@@ -602,9 +591,6 @@ export namespace CustomHostnameCreateResponse {
      */
     serial_number?: string;
 
-    /**
-     * SSL specific settings.
-     */
     settings?: SSL.Settings;
 
     /**
@@ -664,9 +650,6 @@ export namespace CustomHostnameCreateResponse {
   }
 
   export namespace SSL {
-    /**
-     * SSL specific settings.
-     */
     export interface Settings {
       /**
        * An allowlist of ciphers for TLS termination. These ciphers must be in the
@@ -702,15 +685,12 @@ export namespace CustomHostnameCreateResponse {
       message?: string;
     }
 
-    /**
-     * Certificate's required validation record.
-     */
     export interface ValidationRecord {
       /**
        * The set of email addresses that the certificate authority (CA) will use to
        * complete domain validation.
        */
-      emails?: Array<unknown>;
+      emails?: Array<string>;
 
       /**
        * The content that the certificate authority (CA) will expect to find at the
@@ -737,16 +717,6 @@ export namespace CustomHostnameCreateResponse {
     }
   }
 
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
-
   /**
    * This is a record which can be placed to activate a hostname.
    */
@@ -796,9 +766,6 @@ export interface CustomHostnameListResponse {
    */
   hostname: string;
 
-  /**
-   * SSL properties for the custom hostname.
-   */
   ssl: CustomHostnameListResponse.SSL;
 
   /**
@@ -807,9 +774,10 @@ export interface CustomHostnameListResponse {
   created_at?: string;
 
   /**
-   * These are per-hostname (customer) settings.
+   * Unique key/value metadata for this hostname. These are per-hostname (customer)
+   * settings.
    */
-  custom_metadata?: CustomHostnameListResponse.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -861,13 +829,10 @@ export interface CustomHostnameListResponse {
   /**
    * These are errors that were encountered while trying to activate a hostname.
    */
-  verification_errors?: Array<unknown>;
+  verification_errors?: Array<string>;
 }
 
 export namespace CustomHostnameListResponse {
-  /**
-   * SSL properties for the custom hostname.
-   */
   export interface SSL {
     /**
      * Custom hostname SSL identifier tag.
@@ -910,7 +875,7 @@ export namespace CustomHostnameListResponse {
     /**
      * A list of Hostnames on a custom uploaded certificate.
      */
-    hosts?: Array<unknown>;
+    hosts?: Array<string>;
 
     /**
      * The issuer on a custom uploaded certificate.
@@ -927,9 +892,6 @@ export namespace CustomHostnameListResponse {
      */
     serial_number?: string;
 
-    /**
-     * SSL specific settings.
-     */
     settings?: SSL.Settings;
 
     /**
@@ -989,9 +951,6 @@ export namespace CustomHostnameListResponse {
   }
 
   export namespace SSL {
-    /**
-     * SSL specific settings.
-     */
     export interface Settings {
       /**
        * An allowlist of ciphers for TLS termination. These ciphers must be in the
@@ -1027,15 +986,12 @@ export namespace CustomHostnameListResponse {
       message?: string;
     }
 
-    /**
-     * Certificate's required validation record.
-     */
     export interface ValidationRecord {
       /**
        * The set of email addresses that the certificate authority (CA) will use to
        * complete domain validation.
        */
-      emails?: Array<unknown>;
+      emails?: Array<string>;
 
       /**
        * The content that the certificate authority (CA) will expect to find at the
@@ -1062,16 +1018,6 @@ export namespace CustomHostnameListResponse {
     }
   }
 
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
-
   /**
    * This is a record which can be placed to activate a hostname.
    */
@@ -1128,9 +1074,6 @@ export interface CustomHostnameEditResponse {
    */
   hostname: string;
 
-  /**
-   * SSL properties for the custom hostname.
-   */
   ssl: CustomHostnameEditResponse.SSL;
 
   /**
@@ -1139,9 +1082,10 @@ export interface CustomHostnameEditResponse {
   created_at?: string;
 
   /**
-   * These are per-hostname (customer) settings.
+   * Unique key/value metadata for this hostname. These are per-hostname (customer)
+   * settings.
    */
-  custom_metadata?: CustomHostnameEditResponse.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -1193,13 +1137,10 @@ export interface CustomHostnameEditResponse {
   /**
    * These are errors that were encountered while trying to activate a hostname.
    */
-  verification_errors?: Array<unknown>;
+  verification_errors?: Array<string>;
 }
 
 export namespace CustomHostnameEditResponse {
-  /**
-   * SSL properties for the custom hostname.
-   */
   export interface SSL {
     /**
      * Custom hostname SSL identifier tag.
@@ -1242,7 +1183,7 @@ export namespace CustomHostnameEditResponse {
     /**
      * A list of Hostnames on a custom uploaded certificate.
      */
-    hosts?: Array<unknown>;
+    hosts?: Array<string>;
 
     /**
      * The issuer on a custom uploaded certificate.
@@ -1259,9 +1200,6 @@ export namespace CustomHostnameEditResponse {
      */
     serial_number?: string;
 
-    /**
-     * SSL specific settings.
-     */
     settings?: SSL.Settings;
 
     /**
@@ -1321,9 +1259,6 @@ export namespace CustomHostnameEditResponse {
   }
 
   export namespace SSL {
-    /**
-     * SSL specific settings.
-     */
     export interface Settings {
       /**
        * An allowlist of ciphers for TLS termination. These ciphers must be in the
@@ -1359,15 +1294,12 @@ export namespace CustomHostnameEditResponse {
       message?: string;
     }
 
-    /**
-     * Certificate's required validation record.
-     */
     export interface ValidationRecord {
       /**
        * The set of email addresses that the certificate authority (CA) will use to
        * complete domain validation.
        */
-      emails?: Array<unknown>;
+      emails?: Array<string>;
 
       /**
        * The content that the certificate authority (CA) will expect to find at the
@@ -1394,16 +1326,6 @@ export namespace CustomHostnameEditResponse {
     }
   }
 
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
-
   /**
    * This is a record which can be placed to activate a hostname.
    */
@@ -1453,9 +1375,6 @@ export interface CustomHostnameGetResponse {
    */
   hostname: string;
 
-  /**
-   * SSL properties for the custom hostname.
-   */
   ssl: CustomHostnameGetResponse.SSL;
 
   /**
@@ -1464,9 +1383,10 @@ export interface CustomHostnameGetResponse {
   created_at?: string;
 
   /**
-   * These are per-hostname (customer) settings.
+   * Unique key/value metadata for this hostname. These are per-hostname (customer)
+   * settings.
    */
-  custom_metadata?: CustomHostnameGetResponse.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -1518,13 +1438,10 @@ export interface CustomHostnameGetResponse {
   /**
    * These are errors that were encountered while trying to activate a hostname.
    */
-  verification_errors?: Array<unknown>;
+  verification_errors?: Array<string>;
 }
 
 export namespace CustomHostnameGetResponse {
-  /**
-   * SSL properties for the custom hostname.
-   */
   export interface SSL {
     /**
      * Custom hostname SSL identifier tag.
@@ -1567,7 +1484,7 @@ export namespace CustomHostnameGetResponse {
     /**
      * A list of Hostnames on a custom uploaded certificate.
      */
-    hosts?: Array<unknown>;
+    hosts?: Array<string>;
 
     /**
      * The issuer on a custom uploaded certificate.
@@ -1584,9 +1501,6 @@ export namespace CustomHostnameGetResponse {
      */
     serial_number?: string;
 
-    /**
-     * SSL specific settings.
-     */
     settings?: SSL.Settings;
 
     /**
@@ -1646,9 +1560,6 @@ export namespace CustomHostnameGetResponse {
   }
 
   export namespace SSL {
-    /**
-     * SSL specific settings.
-     */
     export interface Settings {
       /**
        * An allowlist of ciphers for TLS termination. These ciphers must be in the
@@ -1684,15 +1595,12 @@ export namespace CustomHostnameGetResponse {
       message?: string;
     }
 
-    /**
-     * Certificate's required validation record.
-     */
     export interface ValidationRecord {
       /**
        * The set of email addresses that the certificate authority (CA) will use to
        * complete domain validation.
        */
-      emails?: Array<unknown>;
+      emails?: Array<string>;
 
       /**
        * The content that the certificate authority (CA) will expect to find at the
@@ -1719,16 +1627,6 @@ export namespace CustomHostnameGetResponse {
     }
   }
 
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
-
   /**
    * This is a record which can be placed to activate a hostname.
    */
@@ -1784,9 +1682,10 @@ export interface CustomHostnameCreateParams {
   ssl: CustomHostnameCreateParams.SSL;
 
   /**
-   * Body param: These are per-hostname (customer) settings.
+   * Body param: Unique key/value metadata for this hostname. These are per-hostname
+   * (customer) settings.
    */
-  custom_metadata?: CustomHostnameCreateParams.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 }
 
 export namespace CustomHostnameCreateParams {
@@ -1807,6 +1706,17 @@ export namespace CustomHostnameCreateParams {
      */
     certificate_authority?: Shared.CertificateCAParam;
 
+    /**
+     * Whether or not to add Cloudflare Branding for the order. This will add a
+     * subdomain of sni.cloudflaressl.com as the Common Name if set to true
+     */
+    cloudflare_branding?: boolean;
+
+    /**
+     * Array of custom certificate and key pairs (1 or 2 pairs allowed)
+     */
+    custom_cert_bundle?: Array<SSL.CustomCERTBundle>;
+
     /**
      * If a custom uploaded certificate is used.
      */
@@ -1840,6 +1750,18 @@ export namespace CustomHostnameCreateParams {
   }
 
   export namespace SSL {
+    export interface CustomCERTBundle {
+      /**
+       * If a custom uploaded certificate is used.
+       */
+      custom_certificate: string;
+
+      /**
+       * The key for a custom uploaded certificate.
+       */
+      custom_key: string;
+    }
+
     /**
      * SSL specific settings.
      */
@@ -1871,16 +1793,6 @@ export namespace CustomHostnameCreateParams {
       tls_1_3?: 'on' | 'off';
     }
   }
-
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
 }
 
 export interface CustomHostnameListParams extends V4PagePaginationArrayParams {
@@ -1932,9 +1844,10 @@ export interface CustomHostnameEditParams {
   zone_id: string;
 
   /**
-   * Body param: These are per-hostname (customer) settings.
+   * Body param: Unique key/value metadata for this hostname. These are per-hostname
+   * (customer) settings.
    */
-  custom_metadata?: CustomHostnameEditParams.CustomMetadata;
+  custom_metadata?: Record<string, string>;
 
   /**
    * Body param: a valid hostname that’s been added to your DNS zone as an A, AAAA,
@@ -1958,16 +1871,6 @@ export interface CustomHostnameEditParams {
 }
 
 export namespace CustomHostnameEditParams {
-  /**
-   * These are per-hostname (customer) settings.
-   */
-  export interface CustomMetadata {
-    /**
-     * Unique metadata for this hostname.
-     */
-    key?: string;
-  }
-
   /**
    * SSL properties used when creating the custom hostname.
    */
@@ -1985,6 +1888,17 @@ export namespace CustomHostnameEditParams {
      */
     certificate_authority?: Shared.CertificateCAParam;
 
+    /**
+     * Whether or not to add Cloudflare Branding for the order. This will add a
+     * subdomain of sni.cloudflaressl.com as the Common Name if set to true
+     */
+    cloudflare_branding?: boolean;
+
+    /**
+     * Array of custom certificate and key pairs (1 or 2 pairs allowed)
+     */
+    custom_cert_bundle?: Array<SSL.CustomCERTBundle>;
+
     /**
      * If a custom uploaded certificate is used.
      */
@@ -2018,6 +1932,18 @@ export namespace CustomHostnameEditParams {
   }
 
   export namespace SSL {
+    export interface CustomCERTBundle {
+      /**
+       * If a custom uploaded certificate is used.
+       */
+      custom_certificate: string;
+
+      /**
+       * The key for a custom uploaded certificate.
+       */
+      custom_key: string;
+    }
+
     /**
      * SSL specific settings.
      */
@@ -2058,12 +1984,19 @@ export interface CustomHostnameGetParams {
   zone_id: string;
 }
 
-export namespace CustomHostnames {
-  export import FallbackOrigin = FallbackOriginAPI.FallbackOrigin;
-  export import FallbackOriginUpdateResponse = FallbackOriginAPI.FallbackOriginUpdateResponse;
-  export import FallbackOriginDeleteResponse = FallbackOriginAPI.FallbackOriginDeleteResponse;
-  export import FallbackOriginGetResponse = FallbackOriginAPI.FallbackOriginGetResponse;
-  export import FallbackOriginUpdateParams = FallbackOriginAPI.FallbackOriginUpdateParams;
-  export import FallbackOriginDeleteParams = FallbackOriginAPI.FallbackOriginDeleteParams;
-  export import FallbackOriginGetParams = FallbackOriginAPI.FallbackOriginGetParams;
+CustomHostnames.FallbackOrigin = FallbackOrigin;
+CustomHostnames.CertificatePack = CertificatePack;
+
+export declare namespace CustomHostnames {
+  export {
+    FallbackOrigin as FallbackOrigin,
+    type FallbackOriginUpdateResponse as FallbackOriginUpdateResponse,
+    type FallbackOriginDeleteResponse as FallbackOriginDeleteResponse,
+    type FallbackOriginGetResponse as FallbackOriginGetResponse,
+    type FallbackOriginUpdateParams as FallbackOriginUpdateParams,
+    type FallbackOriginDeleteParams as FallbackOriginDeleteParams,
+    type FallbackOriginGetParams as FallbackOriginGetParams,
+  };
+
+  export { CertificatePack as CertificatePack };
 }