cloudflare 4.5.0 → 5.0.0

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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../../resource';
 import * as Core from '../../../../core';
 import * as ProfilesCustomAPI from '../profiles/custom';
+import { SinglePage } from '../../../../pagination';
 
 export class Custom extends APIResource {
   /**
@@ -30,7 +31,7 @@ export class Custom extends APIResource {
   }
 
   /**
-   * Updates a DLP entry.
+   * Updates a DLP custom entry.
    *
    * @example
    * ```ts
@@ -39,9 +40,9 @@ export class Custom extends APIResource {
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *     {
    *       account_id: 'account_id',
+   *       enabled: true,
    *       name: 'name',
    *       pattern: { regex: 'regex' },
-   *       type: 'custom',
    *     },
    *   );
    * ```
@@ -53,13 +54,38 @@ export class Custom extends APIResource {
   ): Core.APIPromise<CustomUpdateResponse> {
     const { account_id, ...body } = params;
     return (
-      this._client.put(`/accounts/${account_id}/dlp/entries/${entryId}`, {
+      this._client.put(`/accounts/${account_id}/dlp/entries/custom/${entryId}`, {
         body,
         ...options,
       }) as Core.APIPromise<{ result: CustomUpdateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Lists all DLP entries in an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const customListResponse of client.zeroTrust.dlp.entries.custom.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: CustomListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CustomListResponsesSinglePage, CustomListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/dlp/entries`,
+      CustomListResponsesSinglePage,
+      options,
+    );
+  }
+
   /**
    * Deletes a DLP custom entry.
    *
@@ -84,8 +110,35 @@ export class Custom extends APIResource {
       }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Fetches a DLP entry by ID.
+   *
+   * @example
+   * ```ts
+   * const custom =
+   *   await client.zeroTrust.dlp.entries.custom.get(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  get(
+    entryId: string,
+    params: CustomGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/dlp/entries/${entryId}`, options) as Core.APIPromise<{
+        result: CustomGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
+export class CustomListResponsesSinglePage extends SinglePage<CustomListResponse> {}
+
 export interface CustomCreateResponse {
   id: string;
 
@@ -102,15 +155,31 @@ export interface CustomCreateResponse {
   profile_id?: string | null;
 }
 
-export type CustomUpdateResponse =
-  | CustomUpdateResponse.CustomEntry
-  | CustomUpdateResponse.PredefinedEntry
-  | CustomUpdateResponse.IntegrationEntry
-  | CustomUpdateResponse.ExactDataEntry
-  | CustomUpdateResponse.DocumentFingerprintEntry
-  | CustomUpdateResponse.WordListEntry;
+export interface CustomUpdateResponse {
+  id: string;
+
+  created_at: string;
+
+  enabled: boolean;
+
+  name: string;
+
+  pattern: ProfilesCustomAPI.Pattern;
+
+  updated_at: string;
+
+  profile_id?: string | null;
+}
+
+export type CustomListResponse =
+  | CustomListResponse.CustomEntry
+  | CustomListResponse.PredefinedEntry
+  | CustomListResponse.IntegrationEntry
+  | CustomListResponse.ExactDataEntry
+  | CustomListResponse.DocumentFingerprintEntry
+  | CustomListResponse.WordListEntry;
 
-export namespace CustomUpdateResponse {
+export namespace CustomListResponse {
   export interface CustomEntry {
     id: string;
 
@@ -141,6 +210,8 @@ export namespace CustomUpdateResponse {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -156,6 +227,14 @@ export namespace CustomUpdateResponse {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -231,6 +310,143 @@ export namespace CustomUpdateResponse {
 
 export type CustomDeleteResponse = unknown;
 
+export type CustomGetResponse =
+  | CustomGetResponse.CustomEntry
+  | CustomGetResponse.PredefinedEntry
+  | CustomGetResponse.IntegrationEntry
+  | CustomGetResponse.ExactDataEntry
+  | CustomGetResponse.DocumentFingerprintEntry
+  | CustomGetResponse.WordListEntry;
+
+export namespace CustomGetResponse {
+  export interface CustomEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    pattern: ProfilesCustomAPI.Pattern;
+
+    type: 'custom';
+
+    updated_at: string;
+
+    profile_id?: string | null;
+  }
+
+  export interface PredefinedEntry {
+    id: string;
+
+    confidence: PredefinedEntry.Confidence;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'predefined';
+
+    profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
+  }
+
+  export namespace PredefinedEntry {
+    export interface Confidence {
+      /**
+       * Indicates whether this entry has AI remote service validation.
+       */
+      ai_context_available: boolean;
+
+      /**
+       * Indicates whether this entry has any form of validation that is not an AI remote
+       * service.
+       */
+      available: boolean;
+    }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
+  }
+
+  export interface IntegrationEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'integration';
+
+    updated_at: string;
+
+    profile_id?: string | null;
+  }
+
+  export interface ExactDataEntry {
+    id: string;
+
+    /**
+     * Only applies to custom word lists. Determines if the words should be matched in
+     * a case-sensitive manner Cannot be set to false if secret is true
+     */
+    case_sensitive: boolean;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    secret: boolean;
+
+    type: 'exact_data';
+
+    updated_at: string;
+  }
+
+  export interface DocumentFingerprintEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_fingerprint';
+
+    updated_at: string;
+  }
+
+  export interface WordListEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'word_list';
+
+    updated_at: string;
+
+    word_list: unknown;
+
+    profile_id?: string | null;
+  }
+}
+
 export interface CustomCreateParams {
   /**
    * Path param:
@@ -258,85 +474,54 @@ export interface CustomCreateParams {
   profile_id: string;
 }
 
-export type CustomUpdateParams =
-  | CustomUpdateParams.Variant0
-  | CustomUpdateParams.Variant1
-  | CustomUpdateParams.Variant2;
-
-export declare namespace CustomUpdateParams {
-  export interface Variant0 {
-    /**
-     * Path param:
-     */
-    account_id: string;
-
-    /**
-     * Body param:
-     */
-    name: string;
-
-    /**
-     * Body param:
-     */
-    pattern: ProfilesCustomAPI.PatternParam;
-
-    /**
-     * Body param:
-     */
-    type: 'custom';
-
-    /**
-     * Body param:
-     */
-    enabled?: boolean;
-  }
-
-  export interface Variant1 {
-    /**
-     * Path param:
-     */
-    account_id: string;
-
-    /**
-     * Body param:
-     */
-    type: 'predefined';
+export interface CustomUpdateParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
 
-    /**
-     * Body param:
-     */
-    enabled?: boolean;
-  }
+  /**
+   * Body param:
+   */
+  enabled: boolean;
 
-  export interface Variant2 {
-    /**
-     * Path param:
-     */
-    account_id: string;
+  /**
+   * Body param:
+   */
+  name: string;
 
-    /**
-     * Body param:
-     */
-    type: 'integration';
+  /**
+   * Body param:
+   */
+  pattern: ProfilesCustomAPI.PatternParam;
+}
 
-    /**
-     * Body param:
-     */
-    enabled?: boolean;
-  }
+export interface CustomListParams {
+  account_id: string;
 }
 
 export interface CustomDeleteParams {
   account_id: string;
 }
 
+export interface CustomGetParams {
+  account_id: string;
+}
+
+Custom.CustomListResponsesSinglePage = CustomListResponsesSinglePage;
+
 export declare namespace Custom {
   export {
     type CustomCreateResponse as CustomCreateResponse,
     type CustomUpdateResponse as CustomUpdateResponse,
+    type CustomListResponse as CustomListResponse,
     type CustomDeleteResponse as CustomDeleteResponse,
+    type CustomGetResponse as CustomGetResponse,
+    CustomListResponsesSinglePage as CustomListResponsesSinglePage,
     type CustomCreateParams as CustomCreateParams,
     type CustomUpdateParams as CustomUpdateParams,
+    type CustomListParams as CustomListParams,
     type CustomDeleteParams as CustomDeleteParams,
+    type CustomGetParams as CustomGetParams,
   };
 }

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

@@ -9,6 +9,11 @@ import {
   CustomCreateResponse,
   CustomDeleteParams,
   CustomDeleteResponse,
+  CustomGetParams,
+  CustomGetResponse,
+  CustomListParams,
+  CustomListResponse,
+  CustomListResponsesSinglePage,
   CustomUpdateParams,
   CustomUpdateResponse,
 } from './custom';
@@ -19,6 +24,11 @@ import {
   IntegrationCreateResponse,
   IntegrationDeleteParams,
   IntegrationDeleteResponse,
+  IntegrationGetParams,
+  IntegrationGetResponse,
+  IntegrationListParams,
+  IntegrationListResponse,
+  IntegrationListResponsesSinglePage,
   IntegrationUpdateParams,
   IntegrationUpdateResponse,
 } from './integration';
@@ -29,6 +39,11 @@ import {
   PredefinedCreateResponse,
   PredefinedDeleteParams,
   PredefinedDeleteResponse,
+  PredefinedGetParams,
+  PredefinedGetResponse,
+  PredefinedListParams,
+  PredefinedListResponse,
+  PredefinedListResponsesSinglePage,
   PredefinedUpdateParams,
   PredefinedUpdateResponse,
 } from './predefined';
@@ -224,6 +239,8 @@ export namespace EntryUpdateResponse {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -239,6 +256,14 @@ export namespace EntryUpdateResponse {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -351,6 +376,8 @@ export namespace EntryListResponse {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -366,6 +393,14 @@ export namespace EntryListResponse {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -480,6 +515,8 @@ export namespace EntryGetResponse {
     type: 'predefined';
 
     profile_id?: string | null;
+
+    variant?: PredefinedEntry.Variant;
   }
 
   export namespace PredefinedEntry {
@@ -495,6 +532,14 @@ export namespace EntryGetResponse {
        */
       available: boolean;
     }
+
+    export interface Variant {
+      topic_type: 'Intent' | 'Content';
+
+      type: 'PromptTopic';
+
+      description?: string | null;
+    }
   }
 
   export interface IntegrationEntry {
@@ -677,8 +722,11 @@ export interface EntryGetParams {
 
 Entries.EntryListResponsesSinglePage = EntryListResponsesSinglePage;
 Entries.Custom = Custom;
+Entries.CustomListResponsesSinglePage = CustomListResponsesSinglePage;
 Entries.Predefined = Predefined;
+Entries.PredefinedListResponsesSinglePage = PredefinedListResponsesSinglePage;
 Entries.Integration = Integration;
+Entries.IntegrationListResponsesSinglePage = IntegrationListResponsesSinglePage;
 
 export declare namespace Entries {
   export {
@@ -699,29 +747,44 @@ export declare namespace Entries {
     Custom as Custom,
     type CustomCreateResponse as CustomCreateResponse,
     type CustomUpdateResponse as CustomUpdateResponse,
+    type CustomListResponse as CustomListResponse,
     type CustomDeleteResponse as CustomDeleteResponse,
+    type CustomGetResponse as CustomGetResponse,
+    CustomListResponsesSinglePage as CustomListResponsesSinglePage,
     type CustomCreateParams as CustomCreateParams,
     type CustomUpdateParams as CustomUpdateParams,
+    type CustomListParams as CustomListParams,
     type CustomDeleteParams as CustomDeleteParams,
+    type CustomGetParams as CustomGetParams,
   };
 
   export {
     Predefined as Predefined,
     type PredefinedCreateResponse as PredefinedCreateResponse,
     type PredefinedUpdateResponse as PredefinedUpdateResponse,
+    type PredefinedListResponse as PredefinedListResponse,
     type PredefinedDeleteResponse as PredefinedDeleteResponse,
+    type PredefinedGetResponse as PredefinedGetResponse,
+    PredefinedListResponsesSinglePage as PredefinedListResponsesSinglePage,
     type PredefinedCreateParams as PredefinedCreateParams,
     type PredefinedUpdateParams as PredefinedUpdateParams,
+    type PredefinedListParams as PredefinedListParams,
     type PredefinedDeleteParams as PredefinedDeleteParams,
+    type PredefinedGetParams as PredefinedGetParams,
   };
 
   export {
     Integration as Integration,
     type IntegrationCreateResponse as IntegrationCreateResponse,
     type IntegrationUpdateResponse as IntegrationUpdateResponse,
+    type IntegrationListResponse as IntegrationListResponse,
     type IntegrationDeleteResponse as IntegrationDeleteResponse,
+    type IntegrationGetResponse as IntegrationGetResponse,
+    IntegrationListResponsesSinglePage as IntegrationListResponsesSinglePage,
     type IntegrationCreateParams as IntegrationCreateParams,
     type IntegrationUpdateParams as IntegrationUpdateParams,
+    type IntegrationListParams as IntegrationListParams,
     type IntegrationDeleteParams as IntegrationDeleteParams,
+    type IntegrationGetParams as IntegrationGetParams,
   };
 }

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

@@ -1,13 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
+  CustomListResponsesSinglePage,
   Custom,
   type CustomCreateResponse,
   type CustomUpdateResponse,
+  type CustomListResponse,
   type CustomDeleteResponse,
+  type CustomGetResponse,
   type CustomCreateParams,
   type CustomUpdateParams,
+  type CustomListParams,
   type CustomDeleteParams,
+  type CustomGetParams,
 } from './custom';
 export {
   EntryListResponsesSinglePage,
@@ -24,20 +29,30 @@ export {
   type EntryGetParams,
 } from './entries';
 export {
+  IntegrationListResponsesSinglePage,
   Integration,
   type IntegrationCreateResponse,
   type IntegrationUpdateResponse,
+  type IntegrationListResponse,
   type IntegrationDeleteResponse,
+  type IntegrationGetResponse,
   type IntegrationCreateParams,
   type IntegrationUpdateParams,
+  type IntegrationListParams,
   type IntegrationDeleteParams,
+  type IntegrationGetParams,
 } from './integration';
 export {
+  PredefinedListResponsesSinglePage,
   Predefined,
   type PredefinedCreateResponse,
   type PredefinedUpdateResponse,
+  type PredefinedListResponse,
   type PredefinedDeleteResponse,
+  type PredefinedGetResponse,
   type PredefinedCreateParams,
   type PredefinedUpdateParams,
+  type PredefinedListParams,
   type PredefinedDeleteParams,
+  type PredefinedGetParams,
 } from './predefined';