cloudflare 4.4.0 → 4.5.0

package/src/resources/zero-trust/dlp/profiles/custom.ts

@@ -141,7 +141,7 @@ export interface CustomProfile {
     | CustomProfile.PredefinedEntry
     | CustomProfile.IntegrationEntry
     | CustomProfile.ExactDataEntry
-    | CustomProfile.DocumentTemplateEntry
+    | CustomProfile.DocumentFingerprintEntry
     | CustomProfile.WordListEntry
   >;
 
@@ -253,7 +253,7 @@ export namespace CustomProfile {
     updated_at: string;
   }
 
-  export interface DocumentTemplateEntry {
+  export interface DocumentFingerprintEntry {
     id: string;
 
     created_at: string;
@@ -262,7 +262,7 @@ export namespace CustomProfile {
 
     name: string;
 
-    type: 'document_template';
+    type: 'document_fingerprint';
 
     updated_at: string;
   }
@@ -363,6 +363,7 @@ export interface CustomCreateParams {
     | CustomCreateParams.Predefined
     | CustomCreateParams.Integration
     | CustomCreateParams.ExactData
+    | CustomCreateParams.UnionMember4
   >;
 }
 
@@ -414,6 +415,14 @@ export namespace CustomCreateParams {
 
     entry_type: 'exact_data';
   }
+
+  export interface UnionMember4 {
+    enabled: boolean;
+
+    entry_id: string;
+
+    entry_type: 'document_fingerprint';
+  }
 }
 
 export interface CustomUpdateParams {
@@ -468,7 +477,10 @@ export interface CustomUpdateParams {
    * Body param: Other entries, e.g. predefined or integration.
    */
   shared_entries?: Array<
-    CustomUpdateParams.Predefined | CustomUpdateParams.Integration | CustomUpdateParams.ExactData
+    | CustomUpdateParams.Predefined
+    | CustomUpdateParams.Integration
+    | CustomUpdateParams.ExactData
+    | CustomUpdateParams.UnionMember3
   >;
 }
 
@@ -514,6 +526,14 @@ export namespace CustomUpdateParams {
 
     entry_type: 'exact_data';
   }
+
+  export interface UnionMember3 {
+    enabled: boolean;
+
+    entry_id: string;
+
+    entry_type: 'document_fingerprint';
+  }
 }
 
 export interface CustomDeleteParams {

package/src/resources/zero-trust/dlp/profiles/index.ts

@@ -13,7 +13,10 @@ export {
 export {
   Predefined,
   type PredefinedProfile,
+  type PredefinedDeleteResponse,
+  type PredefinedCreateParams,
   type PredefinedUpdateParams,
+  type PredefinedDeleteParams,
   type PredefinedGetParams,
 } from './predefined';
 export {

package/src/resources/zero-trust/dlp/profiles/predefined.ts

@@ -6,6 +6,31 @@ import * as CustomAPI from './custom';
 import * as ProfilesAPI from './profiles';
 
 export class Predefined extends APIResource {
+  /**
+   * Creates a DLP predefined profile. Only supports enabling/disabling entries.
+   *
+   * @example
+   * ```ts
+   * const profile =
+   *   await client.zeroTrust.dlp.profiles.predefined.create({
+   *     account_id: 'account_id',
+   *     profile_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   });
+   * ```
+   */
+  create(
+    params: PredefinedCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ProfilesAPI.Profile> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/dlp/profiles/predefined`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: ProfilesAPI.Profile }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Updates a DLP predefined profile. Only supports enabling/disabling entries.
    *
@@ -32,6 +57,33 @@ export class Predefined extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * This is a no-op as predefined profiles can't be deleted but is needed for our
+   * generated terraform API
+   *
+   * @example
+   * ```ts
+   * const predefined =
+   *   await client.zeroTrust.dlp.profiles.predefined.delete(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  delete(
+    profileId: string,
+    params: PredefinedDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PredefinedDeleteResponse | null> {
+    const { account_id } = params;
+    return (
+      this._client.delete(
+        `/accounts/${account_id}/dlp/profiles/predefined/${profileId}`,
+        options,
+      ) as Core.APIPromise<{ result: PredefinedDeleteResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Fetches a predefined DLP profile by id.
    *
@@ -72,7 +124,7 @@ export interface PredefinedProfile {
     | PredefinedProfile.PredefinedEntry
     | PredefinedProfile.IntegrationEntry
     | PredefinedProfile.ExactDataEntry
-    | PredefinedProfile.DocumentTemplateEntry
+    | PredefinedProfile.DocumentFingerprintEntry
     | PredefinedProfile.WordListEntry
   >;
 
@@ -185,7 +237,7 @@ export namespace PredefinedProfile {
     updated_at: string;
   }
 
-  export interface DocumentTemplateEntry {
+  export interface DocumentFingerprintEntry {
     id: string;
 
     created_at: string;
@@ -194,7 +246,7 @@ export namespace PredefinedProfile {
 
     name: string;
 
-    type: 'document_template';
+    type: 'document_fingerprint';
 
     updated_at: string;
   }
@@ -218,6 +270,59 @@ export namespace PredefinedProfile {
   }
 }
 
+export type PredefinedDeleteResponse = unknown;
+
+export interface PredefinedCreateParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  profile_id: string;
+
+  /**
+   * Body param:
+   */
+  ai_context_enabled?: boolean;
+
+  /**
+   * Body param:
+   */
+  allowed_match_count?: number | null;
+
+  /**
+   * Body param:
+   */
+  confidence_threshold?: string | null;
+
+  /**
+   * Body param: Scan the context of predefined entries to only return matches
+   * surrounded by keywords.
+   */
+  context_awareness?: ProfilesAPI.ContextAwarenessParam;
+
+  /**
+   * @deprecated Body param:
+   */
+  entries?: Array<PredefinedCreateParams.Entry>;
+
+  /**
+   * Body param:
+   */
+  ocr_enabled?: boolean;
+}
+
+export namespace PredefinedCreateParams {
+  export interface Entry {
+    id: string;
+
+    enabled: boolean;
+  }
+}
+
 export interface PredefinedUpdateParams {
   /**
    * Path param:
@@ -264,6 +369,10 @@ export namespace PredefinedUpdateParams {
   }
 }
 
+export interface PredefinedDeleteParams {
+  account_id: string;
+}
+
 export interface PredefinedGetParams {
   account_id: string;
 }
@@ -271,7 +380,10 @@ export interface PredefinedGetParams {
 export declare namespace Predefined {
   export {
     type PredefinedProfile as PredefinedProfile,
+    type PredefinedDeleteResponse as PredefinedDeleteResponse,
+    type PredefinedCreateParams as PredefinedCreateParams,
     type PredefinedUpdateParams as PredefinedUpdateParams,
+    type PredefinedDeleteParams as PredefinedDeleteParams,
     type PredefinedGetParams as PredefinedGetParams,
   };
 }

package/src/resources/zero-trust/dlp/profiles/profiles.ts

@@ -17,6 +17,9 @@ import {
 import * as PredefinedAPI from './predefined';
 import {
   Predefined,
+  PredefinedCreateParams,
+  PredefinedDeleteParams,
+  PredefinedDeleteResponse,
   PredefinedGetParams,
   PredefinedProfile as PredefinedAPIPredefinedProfile,
   PredefinedUpdateParams,
@@ -138,7 +141,7 @@ export namespace Profile {
       | CustomProfile.PredefinedEntry
       | CustomProfile.IntegrationEntry
       | CustomProfile.ExactDataEntry
-      | CustomProfile.DocumentTemplateEntry
+      | CustomProfile.DocumentFingerprintEntry
       | CustomProfile.WordListEntry
     >;
 
@@ -252,7 +255,7 @@ export namespace Profile {
       updated_at: string;
     }
 
-    export interface DocumentTemplateEntry {
+    export interface DocumentFingerprintEntry {
       id: string;
 
       created_at: string;
@@ -261,7 +264,7 @@ export namespace Profile {
 
       name: string;
 
-      type: 'document_template';
+      type: 'document_fingerprint';
 
       updated_at: string;
     }
@@ -298,7 +301,7 @@ export namespace Profile {
       | PredefinedProfile.PredefinedEntry
       | PredefinedProfile.IntegrationEntry
       | PredefinedProfile.ExactDataEntry
-      | PredefinedProfile.DocumentTemplateEntry
+      | PredefinedProfile.DocumentFingerprintEntry
       | PredefinedProfile.WordListEntry
     >;
 
@@ -413,7 +416,7 @@ export namespace Profile {
       updated_at: string;
     }
 
-    export interface DocumentTemplateEntry {
+    export interface DocumentFingerprintEntry {
       id: string;
 
       created_at: string;
@@ -422,7 +425,7 @@ export namespace Profile {
 
       name: string;
 
-      type: 'document_template';
+      type: 'document_fingerprint';
 
       updated_at: string;
     }
@@ -456,7 +459,7 @@ export namespace Profile {
       | IntegrationProfile.PredefinedEntry
       | IntegrationProfile.IntegrationEntry
       | IntegrationProfile.ExactDataEntry
-      | IntegrationProfile.DocumentTemplateEntry
+      | IntegrationProfile.DocumentFingerprintEntry
       | IntegrationProfile.WordListEntry
     >;
 
@@ -558,7 +561,7 @@ export namespace Profile {
       updated_at: string;
     }
 
-    export interface DocumentTemplateEntry {
+    export interface DocumentFingerprintEntry {
       id: string;
 
       created_at: string;
@@ -567,7 +570,7 @@ export namespace Profile {
 
       name: string;
 
-      type: 'document_template';
+      type: 'document_fingerprint';
 
       updated_at: string;
     }
@@ -657,7 +660,10 @@ export declare namespace Profiles {
   export {
     Predefined as Predefined,
     type PredefinedAPIPredefinedProfile as PredefinedProfile,
+    type PredefinedDeleteResponse as PredefinedDeleteResponse,
+    type PredefinedCreateParams as PredefinedCreateParams,
     type PredefinedUpdateParams as PredefinedUpdateParams,
+    type PredefinedDeleteParams as PredefinedDeleteParams,
     type PredefinedGetParams as PredefinedGetParams,
   };
 }

package/src/resources/zero-trust/gateway/configurations/configurations.ts

@@ -215,6 +215,17 @@ export interface BlockPageSettings {
    */
   name?: string;
 
+  /**
+   * This setting was shared via the Orgs API and cannot be edited by the current
+   * account
+   */
+  read_only?: boolean;
+
+  /**
+   * Account tag of account that shared this setting
+   */
+  source_account?: string;
+
   /**
    * If mode is customized_block_page: suppress detailed info at the bottom of the
    * block page.
@@ -394,6 +405,17 @@ export interface ExtendedEmailMatching {
    * criteria in Firewall policies.
    */
   enabled?: boolean;
+
+  /**
+   * This setting was shared via the Orgs API and cannot be edited by the current
+   * account
+   */
+  read_only?: boolean;
+
+  /**
+   * Account tag of account that shared this setting
+   */
+  source_account?: string;
 }
 
 /**
@@ -441,11 +463,6 @@ export interface GatewayConfigurationSettings {
    */
   antivirus?: AntiVirusSettings | null;
 
-  /**
-   * Setting to enable App Control
-   */
-  'app-control-settings'?: GatewayConfigurationSettings.AppControlSettings | null;
-
   /**
    * Block page layout settings.
    */
@@ -505,16 +522,6 @@ export interface GatewayConfigurationSettings {
 }
 
 export namespace GatewayConfigurationSettings {
-  /**
-   * Setting to enable App Control
-   */
-  export interface AppControlSettings {
-    /**
-     * Enable App Control
-     */
-    enabled?: boolean;
-  }
-
   /**
    * Certificate settings for Gateway TLS interception. If not specified, the
    * Cloudflare Root CA will be used.
@@ -568,11 +575,6 @@ export interface GatewayConfigurationSettingsParam {
    */
   antivirus?: AntiVirusSettingsParam | null;
 
-  /**
-   * Setting to enable App Control
-   */
-  'app-control-settings'?: GatewayConfigurationSettingsParam.AppControlSettings | null;
-
   /**
    * Block page layout settings.
    */
@@ -632,16 +634,6 @@ export interface GatewayConfigurationSettingsParam {
 }
 
 export namespace GatewayConfigurationSettingsParam {
-  /**
-   * Setting to enable App Control
-   */
-  export interface AppControlSettings {
-    /**
-     * Enable App Control
-     */
-    enabled?: boolean;
-  }
-
   /**
    * Certificate settings for Gateway TLS interception. If not specified, the
    * Cloudflare Root CA will be used.

package/src/resources/zero-trust/gateway/lists/lists.ts

@@ -168,18 +168,6 @@ export interface GatewayItem {
   value?: string;
 }
 
-export interface GatewayItemParam {
-  /**
-   * The description of the list item, if present
-   */
-  description?: string;
-
-  /**
-   * The value of the item in a list.
-   */
-  value?: string;
-}
-
 export interface GatewayList {
   /**
    * API Resource UUID tag.
@@ -271,9 +259,23 @@ export interface ListCreateParams {
   description?: string;
 
   /**
-   * Body param: The items in the list.
+   * Body param: items to add to the list.
    */
-  items?: Array<GatewayItemParam>;
+  items?: Array<ListCreateParams.Item>;
+}
+
+export namespace ListCreateParams {
+  export interface Item {
+    /**
+     * The description of the list item, if present
+     */
+    description?: string;
+
+    /**
+     * The value of the item in a list.
+     */
+    value?: string;
+  }
 }
 
 export interface ListUpdateParams {
@@ -293,9 +295,23 @@ export interface ListUpdateParams {
   description?: string;
 
   /**
-   * Body param: The items in the list.
+   * Body param: items to add to the list.
    */
-  items?: Array<GatewayItemParam>;
+  items?: Array<ListUpdateParams.Item>;
+}
+
+export namespace ListUpdateParams {
+  export interface Item {
+    /**
+     * The description of the list item, if present
+     */
+    description?: string;
+
+    /**
+     * The value of the item in a list.
+     */
+    value?: string;
+  }
 }
 
 export interface ListListParams {

package/src/resources/zero-trust/gateway/rules.ts

@@ -417,7 +417,7 @@ export interface RuleSetting {
    * Add custom headers to allowed requests, in the form of key-value pairs. Keys are
    * header names, pointing to an array with its header value(s).
    */
-  add_headers?: Record<string, string> | null;
+  add_headers?: { [key: string]: string } | null;
 
   /**
    * Set by parent MSP accounts to enable their children to bypass this rule.
@@ -846,7 +846,7 @@ export interface RuleSettingParam {
    * Add custom headers to allowed requests, in the form of key-value pairs. Keys are
    * header names, pointing to an array with its header value(s).
    */
-  add_headers?: Record<string, string> | null;
+  add_headers?: { [key: string]: string } | null;
 
   /**
    * Set by parent MSP accounts to enable their children to bypass this rule.

package/src/resources/zero-trust/risk-scoring/behaviours.ts

@@ -53,7 +53,7 @@ export class Behaviours extends APIResource {
 }
 
 export interface BehaviourUpdateResponse {
-  behaviors: Record<string, BehaviourUpdateResponse.Behaviors>;
+  behaviors: { [key: string]: BehaviourUpdateResponse.Behaviors };
 }
 
 export namespace BehaviourUpdateResponse {
@@ -65,7 +65,7 @@ export namespace BehaviourUpdateResponse {
 }
 
 export interface BehaviourGetResponse {
-  behaviors: Record<string, BehaviourGetResponse.Behaviors>;
+  behaviors: { [key: string]: BehaviourGetResponse.Behaviors };
 }
 
 export namespace BehaviourGetResponse {
@@ -89,7 +89,7 @@ export interface BehaviourUpdateParams {
   /**
    * Body param:
    */
-  behaviors: Record<string, BehaviourUpdateParams.Behaviors>;
+  behaviors: { [key: string]: BehaviourUpdateParams.Behaviors };
 }
 
 export namespace BehaviourUpdateParams {

package/src/resources/zones/index.ts

@@ -91,5 +91,10 @@ export {
   type SettingEditParams,
   type SettingGetParams,
 } from './settings';
-export { Subscriptions } from './subscriptions';
+export {
+  Subscriptions,
+  type SubscriptionCreateParams,
+  type SubscriptionUpdateParams,
+  type SubscriptionGetParams,
+} from './subscriptions';
 export { Zones } from './zones';

package/src/resources/zones/subscriptions.ts

@@ -1,5 +1,121 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as Shared from '../shared';
 
-export class Subscriptions extends APIResource {}
+export class Subscriptions extends APIResource {
+  /**
+   * Create a zone subscription, either plan or add-ons.
+   *
+   * @example
+   * ```ts
+   * const subscription =
+   *   await client.zones.subscriptions.create({
+   *     zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+   *   });
+   * ```
+   */
+  create(
+    params: SubscriptionCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Subscription> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.post(`/zones/${zone_id}/subscription`, { body, ...options }) as Core.APIPromise<{
+        result: Shared.Subscription;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Updates zone subscriptions, either plan or add-ons.
+   *
+   * @example
+   * ```ts
+   * const subscription =
+   *   await client.zones.subscriptions.update({
+   *     zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+   *   });
+   * ```
+   */
+  update(
+    params: SubscriptionUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Subscription> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.put(`/zones/${zone_id}/subscription`, { body, ...options }) as Core.APIPromise<{
+        result: Shared.Subscription;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Lists zone subscription details.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.zones.subscriptions.get({
+   *   zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+   * });
+   * ```
+   */
+  get(params: SubscriptionGetParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Subscription> {
+    const { zone_id } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/subscription`, options) as Core.APIPromise<{
+        result: Shared.Subscription;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface SubscriptionCreateParams {
+  /**
+   * Path param: Subscription identifier tag.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: How often the subscription is renewed automatically.
+   */
+  frequency?: 'weekly' | 'monthly' | 'quarterly' | 'yearly';
+
+  /**
+   * Body param: The rate plan applied to the subscription.
+   */
+  rate_plan?: Shared.RatePlanParam;
+}
+
+export interface SubscriptionUpdateParams {
+  /**
+   * Path param: Subscription identifier tag.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: How often the subscription is renewed automatically.
+   */
+  frequency?: 'weekly' | 'monthly' | 'quarterly' | 'yearly';
+
+  /**
+   * Body param: The rate plan applied to the subscription.
+   */
+  rate_plan?: Shared.RatePlanParam;
+}
+
+export interface SubscriptionGetParams {
+  /**
+   * Subscription identifier tag.
+   */
+  zone_id: string;
+}
+
+export declare namespace Subscriptions {
+  export {
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+    type SubscriptionUpdateParams as SubscriptionUpdateParams,
+    type SubscriptionGetParams as SubscriptionGetParams,
+  };
+}