cloudflare 5.0.0 → 5.2.0

package/src/resources/dns/settings/zone.ts

@@ -48,50 +48,50 @@ export interface ZoneEditResponse {
    * Whether to flatten all CNAME records in the zone. Note that, due to DNS
    * limitations, a CNAME record at the zone apex will always be flattened.
    */
-  flatten_all_cnames?: boolean;
+  flatten_all_cnames: boolean;
 
   /**
    * Whether to enable Foundation DNS Advanced Nameservers on the zone.
    */
-  foundation_dns?: boolean;
+  foundation_dns: boolean;
 
   /**
    * Settings for this internal zone.
    */
-  internal_dns?: ZoneEditResponse.InternalDNS;
+  internal_dns: ZoneEditResponse.InternalDNS;
 
   /**
    * Whether to enable multi-provider DNS, which causes Cloudflare to activate the
    * zone even when non-Cloudflare NS records exist, and to respect NS records at the
    * zone apex during outbound zone transfers.
    */
-  multi_provider?: boolean;
+  multi_provider: boolean;
 
   /**
    * Settings determining the nameservers through which the zone should be available.
    */
-  nameservers?: ZoneEditResponse.Nameservers;
+  nameservers: ZoneEditResponse.Nameservers;
 
   /**
    * The time to live (TTL) of the zone's nameserver (NS) records.
    */
-  ns_ttl?: number;
+  ns_ttl: number;
 
   /**
    * Allows a Secondary DNS zone to use (proxied) override records and CNAME
    * flattening at the zone apex.
    */
-  secondary_overrides?: boolean;
+  secondary_overrides: boolean;
 
   /**
    * Components of the zone's SOA record.
    */
-  soa?: ZoneEditResponse.SOA;
+  soa: ZoneEditResponse.SOA;
 
   /**
    * Whether the zone mode is a regular or CDN/DNS only zone.
    */
-  zone_mode?: 'standard' | 'cdn_only' | 'dns_only';
+  zone_mode: 'standard' | 'cdn_only' | 'dns_only';
 }
 
 export namespace ZoneEditResponse {
@@ -128,40 +128,41 @@ export namespace ZoneEditResponse {
      * Time in seconds of being unable to query the primary server after which
      * secondary servers should stop serving the zone.
      */
-    expire: number;
+    expire?: number;
 
     /**
      * The time to live (TTL) for negative caching of records within the zone.
      */
-    min_ttl: number;
+    min_ttl?: number;
 
     /**
-     * The primary nameserver, which may be used for outbound zone transfers.
+     * The primary nameserver, which may be used for outbound zone transfers. If null,
+     * a Cloudflare-assigned value will be used.
      */
-    mname: string;
+    mname?: string | null;
 
     /**
      * Time in seconds after which secondary servers should re-check the SOA record to
      * see if the zone has been updated.
      */
-    refresh: number;
+    refresh?: number;
 
     /**
      * Time in seconds after which secondary servers should retry queries after the
      * primary server was unresponsive.
      */
-    retry: number;
+    retry?: number;
 
     /**
      * The email address of the zone administrator, with the first label representing
      * the local part of the email address.
      */
-    rname: string;
+    rname?: string;
 
     /**
      * The time to live (TTL) of the SOA record itself.
      */
-    ttl: number;
+    ttl?: number;
   }
 }
 
@@ -170,50 +171,50 @@ export interface ZoneGetResponse {
    * Whether to flatten all CNAME records in the zone. Note that, due to DNS
    * limitations, a CNAME record at the zone apex will always be flattened.
    */
-  flatten_all_cnames?: boolean;
+  flatten_all_cnames: boolean;
 
   /**
    * Whether to enable Foundation DNS Advanced Nameservers on the zone.
    */
-  foundation_dns?: boolean;
+  foundation_dns: boolean;
 
   /**
    * Settings for this internal zone.
    */
-  internal_dns?: ZoneGetResponse.InternalDNS;
+  internal_dns: ZoneGetResponse.InternalDNS;
 
   /**
    * Whether to enable multi-provider DNS, which causes Cloudflare to activate the
    * zone even when non-Cloudflare NS records exist, and to respect NS records at the
    * zone apex during outbound zone transfers.
    */
-  multi_provider?: boolean;
+  multi_provider: boolean;
 
   /**
    * Settings determining the nameservers through which the zone should be available.
    */
-  nameservers?: ZoneGetResponse.Nameservers;
+  nameservers: ZoneGetResponse.Nameservers;
 
   /**
    * The time to live (TTL) of the zone's nameserver (NS) records.
    */
-  ns_ttl?: number;
+  ns_ttl: number;
 
   /**
    * Allows a Secondary DNS zone to use (proxied) override records and CNAME
    * flattening at the zone apex.
    */
-  secondary_overrides?: boolean;
+  secondary_overrides: boolean;
 
   /**
    * Components of the zone's SOA record.
    */
-  soa?: ZoneGetResponse.SOA;
+  soa: ZoneGetResponse.SOA;
 
   /**
    * Whether the zone mode is a regular or CDN/DNS only zone.
    */
-  zone_mode?: 'standard' | 'cdn_only' | 'dns_only';
+  zone_mode: 'standard' | 'cdn_only' | 'dns_only';
 }
 
 export namespace ZoneGetResponse {
@@ -250,40 +251,41 @@ export namespace ZoneGetResponse {
      * Time in seconds of being unable to query the primary server after which
      * secondary servers should stop serving the zone.
      */
-    expire: number;
+    expire?: number;
 
     /**
      * The time to live (TTL) for negative caching of records within the zone.
      */
-    min_ttl: number;
+    min_ttl?: number;
 
     /**
-     * The primary nameserver, which may be used for outbound zone transfers.
+     * The primary nameserver, which may be used for outbound zone transfers. If null,
+     * a Cloudflare-assigned value will be used.
      */
-    mname: string;
+    mname?: string | null;
 
     /**
      * Time in seconds after which secondary servers should re-check the SOA record to
      * see if the zone has been updated.
      */
-    refresh: number;
+    refresh?: number;
 
     /**
      * Time in seconds after which secondary servers should retry queries after the
      * primary server was unresponsive.
      */
-    retry: number;
+    retry?: number;
 
     /**
      * The email address of the zone administrator, with the first label representing
      * the local part of the email address.
      */
-    rname: string;
+    rname?: string;
 
     /**
      * The time to live (TTL) of the SOA record itself.
      */
-    ttl: number;
+    ttl?: number;
   }
 }
 
@@ -360,14 +362,14 @@ export namespace ZoneEditParams {
    */
   export interface Nameservers {
     /**
-     * Nameserver type
+     * Configured nameserver set to be used for this zone
      */
-    type: 'cloudflare.standard' | 'custom.account' | 'custom.tenant' | 'custom.zone';
+    ns_set?: number;
 
     /**
-     * Configured nameserver set to be used for this zone
+     * Nameserver type
      */
-    ns_set?: number;
+    type?: 'cloudflare.standard' | 'custom.account' | 'custom.tenant' | 'custom.zone';
   }
 
   /**
@@ -378,40 +380,41 @@ export namespace ZoneEditParams {
      * Time in seconds of being unable to query the primary server after which
      * secondary servers should stop serving the zone.
      */
-    expire: number;
+    expire?: number;
 
     /**
      * The time to live (TTL) for negative caching of records within the zone.
      */
-    min_ttl: number;
+    min_ttl?: number;
 
     /**
-     * The primary nameserver, which may be used for outbound zone transfers.
+     * The primary nameserver, which may be used for outbound zone transfers. If null,
+     * a Cloudflare-assigned value will be used.
      */
-    mname: string;
+    mname?: string | null;
 
     /**
      * Time in seconds after which secondary servers should re-check the SOA record to
      * see if the zone has been updated.
      */
-    refresh: number;
+    refresh?: number;
 
     /**
      * Time in seconds after which secondary servers should retry queries after the
      * primary server was unresponsive.
      */
-    retry: number;
+    retry?: number;
 
     /**
      * The email address of the zone administrator, with the first label representing
      * the local part of the email address.
      */
-    rname: string;
+    rname?: string;
 
     /**
      * The time to live (TTL) of the SOA record itself.
      */
-    ttl: number;
+    ttl?: number;
   }
 }
 

package/src/resources/dns-firewall/dns-firewall.ts

@@ -214,16 +214,30 @@ export interface DNSFirewallCreateResponse {
   ecs_fallback: boolean;
 
   /**
-   * Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Higher TTLs will be
-   * decreased to the maximum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets an upper bound on
+   * this duration. For caching purposes, higher TTLs will be decreased to the
+   * maximum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   maximum_cache_ttl: number;
 
   /**
-   * Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Lower TTLs will be
-   * increased to the minimum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets a lower bound on
+   * this duration. For caching purposes, lower TTLs will be increased to the minimum
+   * value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
+   *
+   * Note that, even with this setting, there is no guarantee that a response will be
+   * cached for at least the specified duration. Cached responses may be removed
+   * earlier for capacity or other operational reasons.
    */
   minimum_cache_ttl: number;
 
@@ -238,8 +252,12 @@ export interface DNSFirewallCreateResponse {
   name: string;
 
   /**
-   * Negative DNS cache TTL This setting controls how long DNS Firewall should cache
-   * negative responses (e.g., NXDOMAIN) from the upstream servers.
+   * This setting controls how long DNS Firewall should cache negative responses
+   * (e.g., NXDOMAIN) from the upstream servers.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   negative_cache_ttl: number | null;
 
@@ -282,16 +300,30 @@ export interface DNSFirewallListResponse {
   ecs_fallback: boolean;
 
   /**
-   * Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Higher TTLs will be
-   * decreased to the maximum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets an upper bound on
+   * this duration. For caching purposes, higher TTLs will be decreased to the
+   * maximum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   maximum_cache_ttl: number;
 
   /**
-   * Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Lower TTLs will be
-   * increased to the minimum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets a lower bound on
+   * this duration. For caching purposes, lower TTLs will be increased to the minimum
+   * value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
+   *
+   * Note that, even with this setting, there is no guarantee that a response will be
+   * cached for at least the specified duration. Cached responses may be removed
+   * earlier for capacity or other operational reasons.
    */
   minimum_cache_ttl: number;
 
@@ -306,8 +338,12 @@ export interface DNSFirewallListResponse {
   name: string;
 
   /**
-   * Negative DNS cache TTL This setting controls how long DNS Firewall should cache
-   * negative responses (e.g., NXDOMAIN) from the upstream servers.
+   * This setting controls how long DNS Firewall should cache negative responses
+   * (e.g., NXDOMAIN) from the upstream servers.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   negative_cache_ttl: number | null;
 
@@ -357,16 +393,30 @@ export interface DNSFirewallEditResponse {
   ecs_fallback: boolean;
 
   /**
-   * Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Higher TTLs will be
-   * decreased to the maximum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets an upper bound on
+   * this duration. For caching purposes, higher TTLs will be decreased to the
+   * maximum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   maximum_cache_ttl: number;
 
   /**
-   * Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Lower TTLs will be
-   * increased to the minimum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets a lower bound on
+   * this duration. For caching purposes, lower TTLs will be increased to the minimum
+   * value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
+   *
+   * Note that, even with this setting, there is no guarantee that a response will be
+   * cached for at least the specified duration. Cached responses may be removed
+   * earlier for capacity or other operational reasons.
    */
   minimum_cache_ttl: number;
 
@@ -381,8 +431,12 @@ export interface DNSFirewallEditResponse {
   name: string;
 
   /**
-   * Negative DNS cache TTL This setting controls how long DNS Firewall should cache
-   * negative responses (e.g., NXDOMAIN) from the upstream servers.
+   * This setting controls how long DNS Firewall should cache negative responses
+   * (e.g., NXDOMAIN) from the upstream servers.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   negative_cache_ttl: number | null;
 
@@ -425,16 +479,30 @@ export interface DNSFirewallGetResponse {
   ecs_fallback: boolean;
 
   /**
-   * Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Higher TTLs will be
-   * decreased to the maximum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets an upper bound on
+   * this duration. For caching purposes, higher TTLs will be decreased to the
+   * maximum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   maximum_cache_ttl: number;
 
   /**
-   * Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
-   * of caching between DNS Firewall and the upstream servers. Lower TTLs will be
-   * increased to the minimum defined here for caching purposes.
+   * By default, Cloudflare attempts to cache responses for as long as indicated by
+   * the TTL received from upstream nameservers. This setting sets a lower bound on
+   * this duration. For caching purposes, lower TTLs will be increased to the minimum
+   * value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
+   *
+   * Note that, even with this setting, there is no guarantee that a response will be
+   * cached for at least the specified duration. Cached responses may be removed
+   * earlier for capacity or other operational reasons.
    */
   minimum_cache_ttl: number;
 
@@ -449,8 +517,12 @@ export interface DNSFirewallGetResponse {
   name: string;
 
   /**
-   * Negative DNS cache TTL This setting controls how long DNS Firewall should cache
-   * negative responses (e.g., NXDOMAIN) from the upstream servers.
+   * This setting controls how long DNS Firewall should cache negative responses
+   * (e.g., NXDOMAIN) from the upstream servers.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   negative_cache_ttl: number | null;
 
@@ -507,22 +579,40 @@ export interface DNSFirewallCreateParams {
   ecs_fallback?: boolean;
 
   /**
-   * Body param: Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs
-   * for purposes of caching between DNS Firewall and the upstream servers. Higher
-   * TTLs will be decreased to the maximum defined here for caching purposes.
+   * Body param: By default, Cloudflare attempts to cache responses for as long as
+   * indicated by the TTL received from upstream nameservers. This setting sets an
+   * upper bound on this duration. For caching purposes, higher TTLs will be
+   * decreased to the maximum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   maximum_cache_ttl?: number;
 
   /**
-   * Body param: Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs
-   * for purposes of caching between DNS Firewall and the upstream servers. Lower
-   * TTLs will be increased to the minimum defined here for caching purposes.
+   * Body param: By default, Cloudflare attempts to cache responses for as long as
+   * indicated by the TTL received from upstream nameservers. This setting sets a
+   * lower bound on this duration. For caching purposes, lower TTLs will be increased
+   * to the minimum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
+   *
+   * Note that, even with this setting, there is no guarantee that a response will be
+   * cached for at least the specified duration. Cached responses may be removed
+   * earlier for capacity or other operational reasons.
    */
   minimum_cache_ttl?: number;
 
   /**
-   * Body param: Negative DNS cache TTL This setting controls how long DNS Firewall
-   * should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
+   * Body param: This setting controls how long DNS Firewall should cache negative
+   * responses (e.g., NXDOMAIN) from the upstream servers.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   negative_cache_ttl?: number | null;
 
@@ -576,16 +666,30 @@ export interface DNSFirewallEditParams {
   ecs_fallback?: boolean;
 
   /**
-   * Body param: Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs
-   * for purposes of caching between DNS Firewall and the upstream servers. Higher
-   * TTLs will be decreased to the maximum defined here for caching purposes.
+   * Body param: By default, Cloudflare attempts to cache responses for as long as
+   * indicated by the TTL received from upstream nameservers. This setting sets an
+   * upper bound on this duration. For caching purposes, higher TTLs will be
+   * decreased to the maximum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   maximum_cache_ttl?: number;
 
   /**
-   * Body param: Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs
-   * for purposes of caching between DNS Firewall and the upstream servers. Lower
-   * TTLs will be increased to the minimum defined here for caching purposes.
+   * Body param: By default, Cloudflare attempts to cache responses for as long as
+   * indicated by the TTL received from upstream nameservers. This setting sets a
+   * lower bound on this duration. For caching purposes, lower TTLs will be increased
+   * to the minimum value defined by this setting.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
+   *
+   * Note that, even with this setting, there is no guarantee that a response will be
+   * cached for at least the specified duration. Cached responses may be removed
+   * earlier for capacity or other operational reasons.
    */
   minimum_cache_ttl?: number;
 
@@ -595,8 +699,12 @@ export interface DNSFirewallEditParams {
   name?: string;
 
   /**
-   * Body param: Negative DNS cache TTL This setting controls how long DNS Firewall
-   * should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
+   * Body param: This setting controls how long DNS Firewall should cache negative
+   * responses (e.g., NXDOMAIN) from the upstream servers.
+   *
+   * This setting does not affect the TTL value in the DNS response Cloudflare
+   * returns to clients. Cloudflare will always forward the TTL value received from
+   * upstream nameservers.
    */
   negative_cache_ttl?: number | null;
 

package/src/resources/email-routing/dns.ts

@@ -14,7 +14,6 @@ export class DNS extends APIResource {
    * ```ts
    * const settings = await client.emailRouting.dns.create({
    *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   name: 'example.net',
    * });
    * ```
    */
@@ -59,7 +58,6 @@ export class DNS extends APIResource {
    * ```ts
    * const settings = await client.emailRouting.dns.edit({
    *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   name: 'example.net',
    * });
    * ```
    */
@@ -314,7 +312,7 @@ export interface DNSCreateParams {
   /**
    * Body param: Domain of your zone.
    */
-  name: string;
+  name?: string;
 }
 
 export interface DNSDeleteParams {
@@ -333,7 +331,7 @@ export interface DNSEditParams {
   /**
    * Body param: Domain of your zone.
    */
-  name: string;
+  name?: string;
 }
 
 export interface DNSGetParams {