cloudflare 4.5.0 → 5.0.0

package/src/resources/spectrum/apps.ts

@@ -15,10 +15,7 @@ export class Apps extends APIResource {
    * const app = await client.spectrum.apps.create({
    *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *   dns: {},
-   *   ip_firewall: true,
    *   protocol: 'tcp/22',
-   *   proxy_protocol: 'off',
-   *   tls: 'full',
    *   traffic_type: 'direct',
    * });
    * ```
@@ -43,10 +40,7 @@ export class Apps extends APIResource {
    *   {
    *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *     dns: {},
-   *     ip_firewall: true,
    *     protocol: 'tcp/22',
-   *     proxy_protocol: 'off',
-   *     tls: 'full',
    *     traffic_type: 'direct',
    *   },
    * );
@@ -131,12 +125,6 @@ export namespace AppCreateResponse {
      */
     dns: SpectrumAPI.DNS;
 
-    /**
-     * Enables IP Access Rules for this application. Notes: Only available for TCP
-     * applications.
-     */
-    ip_firewall: boolean;
-
     /**
      * When the Application was last modified.
      */
@@ -148,19 +136,6 @@ export namespace AppCreateResponse {
      */
     protocol: string;
 
-    /**
-     * Enables Proxy Protocol to the origin. Refer to
-     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
-     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
-     * Proxy Protocol.
-     */
-    proxy_protocol: 'off' | 'v1' | 'v2' | 'simple';
-
-    /**
-     * The type of TLS termination associated with the application.
-     */
-    tls: 'off' | 'flexible' | 'full' | 'strict';
-
     /**
      * Determines how data travels from the edge to your origin. When set to "direct",
      * Spectrum will send traffic directly to your origin, and the application's type
@@ -181,6 +156,12 @@ export namespace AppCreateResponse {
      */
     edge_ips?: SpectrumAPI.EdgeIPs;
 
+    /**
+     * Enables IP Access Rules for this application. Notes: Only available for TCP
+     * applications.
+     */
+    ip_firewall?: boolean;
+
     /**
      * List of origin IP addresses. Array may contain multiple IP addresses for load
      * balancing.
@@ -200,6 +181,19 @@ export namespace AppCreateResponse {
      * range must match the number of ports specified in the "protocol" field.
      */
     origin_port?: SpectrumAPI.OriginPort;
+
+    /**
+     * Enables Proxy Protocol to the origin. Refer to
+     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
+     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
+     * Proxy Protocol.
+     */
+    proxy_protocol?: 'off' | 'v1' | 'v2' | 'simple';
+
+    /**
+     * The type of TLS termination associated with the application.
+     */
+    tls?: 'off' | 'flexible' | 'full' | 'strict';
   }
 
   export interface SpectrumConfigPaygoAppConfig {
@@ -258,12 +252,6 @@ export namespace AppUpdateResponse {
      */
     dns: SpectrumAPI.DNS;
 
-    /**
-     * Enables IP Access Rules for this application. Notes: Only available for TCP
-     * applications.
-     */
-    ip_firewall: boolean;
-
     /**
      * When the Application was last modified.
      */
@@ -275,19 +263,6 @@ export namespace AppUpdateResponse {
      */
     protocol: string;
 
-    /**
-     * Enables Proxy Protocol to the origin. Refer to
-     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
-     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
-     * Proxy Protocol.
-     */
-    proxy_protocol: 'off' | 'v1' | 'v2' | 'simple';
-
-    /**
-     * The type of TLS termination associated with the application.
-     */
-    tls: 'off' | 'flexible' | 'full' | 'strict';
-
     /**
      * Determines how data travels from the edge to your origin. When set to "direct",
      * Spectrum will send traffic directly to your origin, and the application's type
@@ -308,6 +283,12 @@ export namespace AppUpdateResponse {
      */
     edge_ips?: SpectrumAPI.EdgeIPs;
 
+    /**
+     * Enables IP Access Rules for this application. Notes: Only available for TCP
+     * applications.
+     */
+    ip_firewall?: boolean;
+
     /**
      * List of origin IP addresses. Array may contain multiple IP addresses for load
      * balancing.
@@ -327,6 +308,19 @@ export namespace AppUpdateResponse {
      * range must match the number of ports specified in the "protocol" field.
      */
     origin_port?: SpectrumAPI.OriginPort;
+
+    /**
+     * Enables Proxy Protocol to the origin. Refer to
+     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
+     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
+     * Proxy Protocol.
+     */
+    proxy_protocol?: 'off' | 'v1' | 'v2' | 'simple';
+
+    /**
+     * The type of TLS termination associated with the application.
+     */
+    tls?: 'off' | 'flexible' | 'full' | 'strict';
   }
 
   export interface SpectrumConfigPaygoAppConfig {
@@ -383,12 +377,6 @@ export namespace AppListResponse {
      */
     dns: SpectrumAPI.DNS;
 
-    /**
-     * Enables IP Access Rules for this application. Notes: Only available for TCP
-     * applications.
-     */
-    ip_firewall: boolean;
-
     /**
      * When the Application was last modified.
      */
@@ -400,19 +388,6 @@ export namespace AppListResponse {
      */
     protocol: string;
 
-    /**
-     * Enables Proxy Protocol to the origin. Refer to
-     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
-     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
-     * Proxy Protocol.
-     */
-    proxy_protocol: 'off' | 'v1' | 'v2' | 'simple';
-
-    /**
-     * The type of TLS termination associated with the application.
-     */
-    tls: 'off' | 'flexible' | 'full' | 'strict';
-
     /**
      * Determines how data travels from the edge to your origin. When set to "direct",
      * Spectrum will send traffic directly to your origin, and the application's type
@@ -433,6 +408,12 @@ export namespace AppListResponse {
      */
     edge_ips?: SpectrumAPI.EdgeIPs;
 
+    /**
+     * Enables IP Access Rules for this application. Notes: Only available for TCP
+     * applications.
+     */
+    ip_firewall?: boolean;
+
     /**
      * List of origin IP addresses. Array may contain multiple IP addresses for load
      * balancing.
@@ -452,6 +433,19 @@ export namespace AppListResponse {
      * range must match the number of ports specified in the "protocol" field.
      */
     origin_port?: SpectrumAPI.OriginPort;
+
+    /**
+     * Enables Proxy Protocol to the origin. Refer to
+     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
+     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
+     * Proxy Protocol.
+     */
+    proxy_protocol?: 'off' | 'v1' | 'v2' | 'simple';
+
+    /**
+     * The type of TLS termination associated with the application.
+     */
+    tls?: 'off' | 'flexible' | 'full' | 'strict';
   }
 
   export interface UnionMember1 {
@@ -517,12 +511,6 @@ export namespace AppGetResponse {
      */
     dns: SpectrumAPI.DNS;
 
-    /**
-     * Enables IP Access Rules for this application. Notes: Only available for TCP
-     * applications.
-     */
-    ip_firewall: boolean;
-
     /**
      * When the Application was last modified.
      */
@@ -534,19 +522,6 @@ export namespace AppGetResponse {
      */
     protocol: string;
 
-    /**
-     * Enables Proxy Protocol to the origin. Refer to
-     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
-     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
-     * Proxy Protocol.
-     */
-    proxy_protocol: 'off' | 'v1' | 'v2' | 'simple';
-
-    /**
-     * The type of TLS termination associated with the application.
-     */
-    tls: 'off' | 'flexible' | 'full' | 'strict';
-
     /**
      * Determines how data travels from the edge to your origin. When set to "direct",
      * Spectrum will send traffic directly to your origin, and the application's type
@@ -567,6 +542,12 @@ export namespace AppGetResponse {
      */
     edge_ips?: SpectrumAPI.EdgeIPs;
 
+    /**
+     * Enables IP Access Rules for this application. Notes: Only available for TCP
+     * applications.
+     */
+    ip_firewall?: boolean;
+
     /**
      * List of origin IP addresses. Array may contain multiple IP addresses for load
      * balancing.
@@ -586,6 +567,19 @@ export namespace AppGetResponse {
      * range must match the number of ports specified in the "protocol" field.
      */
     origin_port?: SpectrumAPI.OriginPort;
+
+    /**
+     * Enables Proxy Protocol to the origin. Refer to
+     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
+     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
+     * Proxy Protocol.
+     */
+    proxy_protocol?: 'off' | 'v1' | 'v2' | 'simple';
+
+    /**
+     * The type of TLS termination associated with the application.
+     */
+    tls?: 'off' | 'flexible' | 'full' | 'strict';
   }
 
   export interface SpectrumConfigPaygoAppConfig {
@@ -639,12 +633,6 @@ export declare namespace AppCreateParams {
      */
     dns: SpectrumAPI.DNSParam;
 
-    /**
-     * Body param: Enables IP Access Rules for this application. Notes: Only available
-     * for TCP applications.
-     */
-    ip_firewall: boolean;
-
     /**
      * Body param: The port configuration at Cloudflare's edge. May specify a single
      * port, for example `"tcp/1000"`, or a range of ports, for example
@@ -652,19 +640,6 @@ export declare namespace AppCreateParams {
      */
     protocol: string;
 
-    /**
-     * Body param: Enables Proxy Protocol to the origin. Refer to
-     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
-     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
-     * Proxy Protocol.
-     */
-    proxy_protocol: 'off' | 'v1' | 'v2' | 'simple';
-
-    /**
-     * Body param: The type of TLS termination associated with the application.
-     */
-    tls: 'off' | 'flexible' | 'full' | 'strict';
-
     /**
      * Body param: Determines how data travels from the edge to your origin. When set
      * to "direct", Spectrum will send traffic directly to your origin, and the
@@ -686,6 +661,12 @@ export declare namespace AppCreateParams {
      */
     edge_ips?: SpectrumAPI.EdgeIPsParam;
 
+    /**
+     * Body param: Enables IP Access Rules for this application. Notes: Only available
+     * for TCP applications.
+     */
+    ip_firewall?: boolean;
+
     /**
      * Body param: List of origin IP addresses. Array may contain multiple IP addresses
      * for load balancing.
@@ -705,6 +686,19 @@ export declare namespace AppCreateParams {
      * range must match the number of ports specified in the "protocol" field.
      */
     origin_port?: SpectrumAPI.OriginPortParam;
+
+    /**
+     * Body param: Enables Proxy Protocol to the origin. Refer to
+     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
+     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
+     * Proxy Protocol.
+     */
+    proxy_protocol?: 'off' | 'v1' | 'v2' | 'simple';
+
+    /**
+     * Body param: The type of TLS termination associated with the application.
+     */
+    tls?: 'off' | 'flexible' | 'full' | 'strict';
   }
 
   export interface SpectrumConfigPaygoAppConfig {
@@ -749,12 +743,6 @@ export declare namespace AppUpdateParams {
      */
     dns: SpectrumAPI.DNSParam;
 
-    /**
-     * Body param: Enables IP Access Rules for this application. Notes: Only available
-     * for TCP applications.
-     */
-    ip_firewall: boolean;
-
     /**
      * Body param: The port configuration at Cloudflare's edge. May specify a single
      * port, for example `"tcp/1000"`, or a range of ports, for example
@@ -762,19 +750,6 @@ export declare namespace AppUpdateParams {
      */
     protocol: string;
 
-    /**
-     * Body param: Enables Proxy Protocol to the origin. Refer to
-     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
-     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
-     * Proxy Protocol.
-     */
-    proxy_protocol: 'off' | 'v1' | 'v2' | 'simple';
-
-    /**
-     * Body param: The type of TLS termination associated with the application.
-     */
-    tls: 'off' | 'flexible' | 'full' | 'strict';
-
     /**
      * Body param: Determines how data travels from the edge to your origin. When set
      * to "direct", Spectrum will send traffic directly to your origin, and the
@@ -796,6 +771,12 @@ export declare namespace AppUpdateParams {
      */
     edge_ips?: SpectrumAPI.EdgeIPsParam;
 
+    /**
+     * Body param: Enables IP Access Rules for this application. Notes: Only available
+     * for TCP applications.
+     */
+    ip_firewall?: boolean;
+
     /**
      * Body param: List of origin IP addresses. Array may contain multiple IP addresses
      * for load balancing.
@@ -815,6 +796,19 @@ export declare namespace AppUpdateParams {
      * range must match the number of ports specified in the "protocol" field.
      */
     origin_port?: SpectrumAPI.OriginPortParam;
+
+    /**
+     * Body param: Enables Proxy Protocol to the origin. Refer to
+     * [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/)
+     * for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple
+     * Proxy Protocol.
+     */
+    proxy_protocol?: 'off' | 'v1' | 'v2' | 'simple';
+
+    /**
+     * Body param: The type of TLS termination associated with the application.
+     */
+    tls?: 'off' | 'flexible' | 'full' | 'strict';
   }
 
   export interface SpectrumConfigPaygoAppConfig {

package/src/resources/ssl/certificate-packs/certificate-packs.ts

@@ -227,19 +227,82 @@ export interface CertificatePackCreateResponse {
   /**
    * Type of certificate pack.
    */
-  type?: 'advanced';
+  type?:
+    | 'mh_custom'
+    | 'managed_hostname'
+    | 'sni_custom'
+    | 'universal'
+    | 'advanced'
+    | 'total_tls'
+    | 'keyless'
+    | 'legacy_custom';
+
+  /**
+   * Domain validation errors that have been received by the certificate authority
+   * (CA).
+   */
+  validation_errors?: Array<CertificatePackCreateResponse.ValidationError>;
 
   /**
    * Validation Method selected for the order.
    */
   validation_method?: 'txt' | 'http' | 'email';
 
+  /**
+   * Certificates' validation records. Only present when certificate pack is in
+   * "pending_validation" status
+   */
+  validation_records?: Array<CertificatePackCreateResponse.ValidationRecord>;
+
   /**
    * Validity Days selected for the order.
    */
   validity_days?: 14 | 30 | 90 | 365;
 }
 
+export namespace CertificatePackCreateResponse {
+  export interface ValidationError {
+    /**
+     * A domain validation error.
+     */
+    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<string>;
+
+    /**
+     * The content that the certificate authority (CA) will expect to find at the
+     * http_url during the domain validation.
+     */
+    http_body?: string;
+
+    /**
+     * The url that will be checked during domain validation.
+     */
+    http_url?: string;
+
+    /**
+     * The hostname that the certificate authority (CA) will check for a TXT record
+     * during domain validation .
+     */
+    txt_name?: string;
+
+    /**
+     * The TXT record that the certificate authority (CA) will check during domain
+     * validation.
+     */
+    txt_value?: string;
+  }
+}
+
 export type CertificatePackListResponse = unknown;
 
 export interface CertificatePackDeleteResponse {
@@ -282,19 +345,82 @@ export interface CertificatePackEditResponse {
   /**
    * Type of certificate pack.
    */
-  type?: 'advanced';
+  type?:
+    | 'mh_custom'
+    | 'managed_hostname'
+    | 'sni_custom'
+    | 'universal'
+    | 'advanced'
+    | 'total_tls'
+    | 'keyless'
+    | 'legacy_custom';
+
+  /**
+   * Domain validation errors that have been received by the certificate authority
+   * (CA).
+   */
+  validation_errors?: Array<CertificatePackEditResponse.ValidationError>;
 
   /**
    * Validation Method selected for the order.
    */
   validation_method?: 'txt' | 'http' | 'email';
 
+  /**
+   * Certificates' validation records. Only present when certificate pack is in
+   * "pending_validation" status
+   */
+  validation_records?: Array<CertificatePackEditResponse.ValidationRecord>;
+
   /**
    * Validity Days selected for the order.
    */
   validity_days?: 14 | 30 | 90 | 365;
 }
 
+export namespace CertificatePackEditResponse {
+  export interface ValidationError {
+    /**
+     * A domain validation error.
+     */
+    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<string>;
+
+    /**
+     * The content that the certificate authority (CA) will expect to find at the
+     * http_url during the domain validation.
+     */
+    http_body?: string;
+
+    /**
+     * The url that will be checked during domain validation.
+     */
+    http_url?: string;
+
+    /**
+     * The hostname that the certificate authority (CA) will check for a TXT record
+     * during domain validation .
+     */
+    txt_name?: string;
+
+    /**
+     * The TXT record that the certificate authority (CA) will check during domain
+     * validation.
+     */
+    txt_value?: string;
+  }
+}
+
 export type CertificatePackGetResponse = unknown;
 
 export interface CertificatePackCreateParams {

package/src/resources/ssl/recommendations.ts

@@ -7,12 +7,7 @@ export class Recommendations extends APIResource {
   /**
    * Retrieve the SSL/TLS Recommender's recommendation for a zone.
    *
-   * @example
-   * ```ts
-   * const recommendation = await client.ssl.recommendations.get(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated SSL/TLS Recommender has been decommissioned in favor of Automatic SSL/TLS
    */
   get(
     params: RecommendationGetParams,
@@ -28,20 +23,30 @@ export class Recommendations extends APIResource {
 }
 
 export interface RecommendationGetResponse {
+  id: string;
+
   /**
-   * Identifier of a recommendation result.
+   * Whether this setting can be updated or not.
    */
-  id?: string;
+  editable: boolean;
 
-  modified_on?: string;
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on: string;
 
-  value?: 'flexible' | 'full' | 'strict';
-}
+  /**
+   * Current setting of the automatic SSL/TLS.
+   */
+  value: 'auto' | 'custom';
 
-export interface RecommendationGetParams {
   /**
-   * Identifier.
+   * Next time this zone will be scanned by the Automatic SSL/TLS.
    */
+  next_scheduled_scan?: string | null;
+}
+
+export interface RecommendationGetParams {
   zone_id: string;
 }
 

package/src/resources/stream/clip.ts

@@ -96,7 +96,7 @@ export interface Clip {
   /**
    * Specifies the processing status for all quality levels for a video.
    */
-  status?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error';
+  status?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error' | 'live-inprogress';
 
   /**
    * The timestamp for a thumbnail image calculated as a percentage value of the

package/src/resources/stream/stream.ts

@@ -413,7 +413,7 @@ export namespace Video {
     /**
      * Specifies the processing status for all quality levels for a video.
      */
-    state?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error';
+    state?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error' | 'live-inprogress';
   }
 }
 
@@ -489,8 +489,9 @@ export interface StreamListParams {
   include_counts?: boolean;
 
   /**
-   * Query param: Searches over the `name` key in the `meta` field. This field can be
-   * set with or after the upload request.
+   * Query param: Provides a partial word match of the `name` key in the `meta`
+   * field. Slow for medium to large video libraries. May be unavailable for very
+   * large libraries.
    */
   search?: string;
 
@@ -502,12 +503,18 @@ export interface StreamListParams {
   /**
    * Query param: Specifies the processing status for all quality levels for a video.
    */
-  status?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error';
+  status?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error' | 'live-inprogress';
 
   /**
    * Query param: Specifies whether the video is `vod` or `live`.
    */
   type?: string;
+
+  /**
+   * Query param: Provides a fast, exact string match on the `name` key in the `meta`
+   * field.
+   */
+  video_name?: string;
 }
 
 export interface StreamDeleteParams {