cloudflare 4.5.0 → 5.0.0

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

@@ -2,10 +2,13 @@
 
 import { APIResource } from '../../../../resource';
 import * as Core from '../../../../core';
+import * as CustomAPI from '../profiles/custom';
+import { SinglePage } from '../../../../pagination';
 
 export class Integration extends APIResource {
   /**
-   * This will update an existing integration entry
+   * Integration entries can't be created, this will update an existing integration
+   * entry This is needed for our generated terraform API
    *
    * @example
    * ```ts
@@ -56,6 +59,31 @@ export class Integration extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Lists all DLP entries in an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const integrationListResponse of client.zeroTrust.dlp.entries.integration.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: IntegrationListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<IntegrationListResponsesSinglePage, IntegrationListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/dlp/entries`,
+      IntegrationListResponsesSinglePage,
+      options,
+    );
+  }
+
   /**
    * This is a no-op as integration entires can't be deleted but is needed for our
    * generated terraform API
@@ -82,8 +110,35 @@ export class Integration extends APIResource {
       ) as Core.APIPromise<{ result: IntegrationDeleteResponse | null }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Fetches a DLP entry by ID.
+   *
+   * @example
+   * ```ts
+   * const integration =
+   *   await client.zeroTrust.dlp.entries.integration.get(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  get(
+    entryId: string,
+    params: IntegrationGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<IntegrationGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/dlp/entries/${entryId}`, options) as Core.APIPromise<{
+        result: IntegrationGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
+export class IntegrationListResponsesSinglePage extends SinglePage<IntegrationListResponse> {}
+
 export interface IntegrationCreateResponse {
   id: string;
 
@@ -112,8 +167,282 @@ export interface IntegrationUpdateResponse {
   profile_id?: string | null;
 }
 
+export type IntegrationListResponse =
+  | IntegrationListResponse.CustomEntry
+  | IntegrationListResponse.PredefinedEntry
+  | IntegrationListResponse.IntegrationEntry
+  | IntegrationListResponse.ExactDataEntry
+  | IntegrationListResponse.DocumentFingerprintEntry
+  | IntegrationListResponse.WordListEntry;
+
+export namespace IntegrationListResponse {
+  export interface CustomEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    pattern: CustomAPI.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 type IntegrationDeleteResponse = unknown;
 
+export type IntegrationGetResponse =
+  | IntegrationGetResponse.CustomEntry
+  | IntegrationGetResponse.PredefinedEntry
+  | IntegrationGetResponse.IntegrationEntry
+  | IntegrationGetResponse.ExactDataEntry
+  | IntegrationGetResponse.DocumentFingerprintEntry
+  | IntegrationGetResponse.WordListEntry;
+
+export namespace IntegrationGetResponse {
+  export interface CustomEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    pattern: CustomAPI.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 IntegrationCreateParams {
   /**
    * Path param:
@@ -149,17 +478,32 @@ export interface IntegrationUpdateParams {
   enabled: boolean;
 }
 
+export interface IntegrationListParams {
+  account_id: string;
+}
+
 export interface IntegrationDeleteParams {
   account_id: string;
 }
 
+export interface IntegrationGetParams {
+  account_id: string;
+}
+
+Integration.IntegrationListResponsesSinglePage = IntegrationListResponsesSinglePage;
+
 export declare namespace Integration {
   export {
     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,
   };
 }