cloudflare 4.4.0 → 4.5.0

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

@@ -0,0 +1,727 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as Core from '../../../../core';
+import * as CustomAPI from './custom';
+import {
+  Custom,
+  CustomCreateParams,
+  CustomCreateResponse,
+  CustomDeleteParams,
+  CustomDeleteResponse,
+  CustomUpdateParams,
+  CustomUpdateResponse,
+} from './custom';
+import * as IntegrationAPI from './integration';
+import {
+  Integration,
+  IntegrationCreateParams,
+  IntegrationCreateResponse,
+  IntegrationDeleteParams,
+  IntegrationDeleteResponse,
+  IntegrationUpdateParams,
+  IntegrationUpdateResponse,
+} from './integration';
+import * as PredefinedAPI from './predefined';
+import {
+  Predefined,
+  PredefinedCreateParams,
+  PredefinedCreateResponse,
+  PredefinedDeleteParams,
+  PredefinedDeleteResponse,
+  PredefinedUpdateParams,
+  PredefinedUpdateResponse,
+} from './predefined';
+import * as ProfilesCustomAPI from '../profiles/custom';
+import { SinglePage } from '../../../../pagination';
+
+export class Entries extends APIResource {
+  custom: CustomAPI.Custom = new CustomAPI.Custom(this._client);
+  predefined: PredefinedAPI.Predefined = new PredefinedAPI.Predefined(this._client);
+  integration: IntegrationAPI.Integration = new IntegrationAPI.Integration(this._client);
+
+  /**
+   * Creates a DLP custom entry.
+   *
+   * @example
+   * ```ts
+   * const entry = await client.zeroTrust.dlp.entries.create({
+   *   account_id: 'account_id',
+   *   enabled: true,
+   *   name: 'name',
+   *   pattern: { regex: 'regex' },
+   *   profile_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * });
+   * ```
+   */
+  create(params: EntryCreateParams, options?: Core.RequestOptions): Core.APIPromise<EntryCreateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/dlp/entries`, { body, ...options }) as Core.APIPromise<{
+        result: EntryCreateResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Updates a DLP entry.
+   *
+   * @example
+   * ```ts
+   * const entry = await client.zeroTrust.dlp.entries.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     account_id: 'account_id',
+   *     name: 'name',
+   *     pattern: { regex: 'regex' },
+   *     type: 'custom',
+   *   },
+   * );
+   * ```
+   */
+  update(
+    entryId: string,
+    params: EntryUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EntryUpdateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.put(`/accounts/${account_id}/dlp/entries/${entryId}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: EntryUpdateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Lists all DLP entries in an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const entryListResponse of client.zeroTrust.dlp.entries.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: EntryListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<EntryListResponsesSinglePage, EntryListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/dlp/entries`,
+      EntryListResponsesSinglePage,
+      options,
+    );
+  }
+
+  /**
+   * Deletes a DLP custom entry.
+   *
+   * @example
+   * ```ts
+   * const entry = await client.zeroTrust.dlp.entries.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { account_id: 'account_id' },
+   * );
+   * ```
+   */
+  delete(
+    entryId: string,
+    params: EntryDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EntryDeleteResponse | null> {
+    const { account_id } = params;
+    return (
+      this._client.delete(`/accounts/${account_id}/dlp/entries/${entryId}`, options) as Core.APIPromise<{
+        result: EntryDeleteResponse | null;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Fetches a DLP entry by ID.
+   *
+   * @example
+   * ```ts
+   * const entry = await client.zeroTrust.dlp.entries.get(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { account_id: 'account_id' },
+   * );
+   * ```
+   */
+  get(
+    entryId: string,
+    params: EntryGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EntryGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/dlp/entries/${entryId}`, options) as Core.APIPromise<{
+        result: EntryGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class EntryListResponsesSinglePage extends SinglePage<EntryListResponse> {}
+
+export interface EntryCreateResponse {
+  id: string;
+
+  created_at: string;
+
+  enabled: boolean;
+
+  name: string;
+
+  pattern: ProfilesCustomAPI.Pattern;
+
+  updated_at: string;
+
+  profile_id?: string | null;
+}
+
+export type EntryUpdateResponse =
+  | EntryUpdateResponse.CustomEntry
+  | EntryUpdateResponse.PredefinedEntry
+  | EntryUpdateResponse.IntegrationEntry
+  | EntryUpdateResponse.ExactDataEntry
+  | EntryUpdateResponse.DocumentFingerprintEntry
+  | EntryUpdateResponse.WordListEntry;
+
+export namespace EntryUpdateResponse {
+  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;
+  }
+
+  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 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 EntryListResponse =
+  | EntryListResponse.CustomEntry
+  | EntryListResponse.PredefinedEntry
+  | EntryListResponse.IntegrationEntry
+  | EntryListResponse.ExactDataEntry
+  | EntryListResponse.DocumentFingerprintEntry
+  | EntryListResponse.WordListEntry;
+
+export namespace EntryListResponse {
+  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;
+  }
+
+  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 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 EntryDeleteResponse = unknown;
+
+export type EntryGetResponse =
+  | EntryGetResponse.CustomEntry
+  | EntryGetResponse.PredefinedEntry
+  | EntryGetResponse.IntegrationEntry
+  | EntryGetResponse.ExactDataEntry
+  | EntryGetResponse.DocumentFingerprintEntry
+  | EntryGetResponse.WordListEntry;
+
+export namespace EntryGetResponse {
+  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;
+  }
+
+  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 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 EntryCreateParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  enabled: boolean;
+
+  /**
+   * Body param:
+   */
+  name: string;
+
+  /**
+   * Body param:
+   */
+  pattern: ProfilesCustomAPI.PatternParam;
+
+  /**
+   * Body param:
+   */
+  profile_id: string;
+}
+
+export type EntryUpdateParams =
+  | EntryUpdateParams.Variant0
+  | EntryUpdateParams.Variant1
+  | EntryUpdateParams.Variant2;
+
+export declare namespace EntryUpdateParams {
+  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';
+
+    /**
+     * Body param:
+     */
+    enabled?: boolean;
+  }
+
+  export interface Variant2 {
+    /**
+     * Path param:
+     */
+    account_id: string;
+
+    /**
+     * Body param:
+     */
+    type: 'integration';
+
+    /**
+     * Body param:
+     */
+    enabled?: boolean;
+  }
+}
+
+export interface EntryListParams {
+  account_id: string;
+}
+
+export interface EntryDeleteParams {
+  account_id: string;
+}
+
+export interface EntryGetParams {
+  account_id: string;
+}
+
+Entries.EntryListResponsesSinglePage = EntryListResponsesSinglePage;
+Entries.Custom = Custom;
+Entries.Predefined = Predefined;
+Entries.Integration = Integration;
+
+export declare namespace Entries {
+  export {
+    type EntryCreateResponse as EntryCreateResponse,
+    type EntryUpdateResponse as EntryUpdateResponse,
+    type EntryListResponse as EntryListResponse,
+    type EntryDeleteResponse as EntryDeleteResponse,
+    type EntryGetResponse as EntryGetResponse,
+    EntryListResponsesSinglePage as EntryListResponsesSinglePage,
+    type EntryCreateParams as EntryCreateParams,
+    type EntryUpdateParams as EntryUpdateParams,
+    type EntryListParams as EntryListParams,
+    type EntryDeleteParams as EntryDeleteParams,
+    type EntryGetParams as EntryGetParams,
+  };
+
+  export {
+    Custom as Custom,
+    type CustomCreateResponse as CustomCreateResponse,
+    type CustomUpdateResponse as CustomUpdateResponse,
+    type CustomDeleteResponse as CustomDeleteResponse,
+    type CustomCreateParams as CustomCreateParams,
+    type CustomUpdateParams as CustomUpdateParams,
+    type CustomDeleteParams as CustomDeleteParams,
+  };
+
+  export {
+    Predefined as Predefined,
+    type PredefinedCreateResponse as PredefinedCreateResponse,
+    type PredefinedUpdateResponse as PredefinedUpdateResponse,
+    type PredefinedDeleteResponse as PredefinedDeleteResponse,
+    type PredefinedCreateParams as PredefinedCreateParams,
+    type PredefinedUpdateParams as PredefinedUpdateParams,
+    type PredefinedDeleteParams as PredefinedDeleteParams,
+  };
+
+  export {
+    Integration as Integration,
+    type IntegrationCreateResponse as IntegrationCreateResponse,
+    type IntegrationUpdateResponse as IntegrationUpdateResponse,
+    type IntegrationDeleteResponse as IntegrationDeleteResponse,
+    type IntegrationCreateParams as IntegrationCreateParams,
+    type IntegrationUpdateParams as IntegrationUpdateParams,
+    type IntegrationDeleteParams as IntegrationDeleteParams,
+  };
+}