cloudflare 4.4.1 → 5.0.0

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

@@ -0,0 +1,527 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as Core from '../../../../core';
+import * as ProfilesCustomAPI from '../profiles/custom';
+import { SinglePage } from '../../../../pagination';
+
+export class Custom extends APIResource {
+  /**
+   * Creates a DLP custom entry.
+   *
+   * @example
+   * ```ts
+   * const custom =
+   *   await client.zeroTrust.dlp.entries.custom.create({
+   *     account_id: 'account_id',
+   *     enabled: true,
+   *     name: 'name',
+   *     pattern: { regex: 'regex' },
+   *     profile_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   });
+   * ```
+   */
+  create(params: CustomCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomCreateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/dlp/entries`, { body, ...options }) as Core.APIPromise<{
+        result: CustomCreateResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Updates a DLP custom entry.
+   *
+   * @example
+   * ```ts
+   * const custom =
+   *   await client.zeroTrust.dlp.entries.custom.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       account_id: 'account_id',
+   *       enabled: true,
+   *       name: 'name',
+   *       pattern: { regex: 'regex' },
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    entryId: string,
+    params: CustomUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomUpdateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      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.
+   *
+   * @example
+   * ```ts
+   * const custom =
+   *   await client.zeroTrust.dlp.entries.custom.delete(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  delete(
+    entryId: string,
+    params: CustomDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomDeleteResponse | null> {
+    const { account_id } = params;
+    return (
+      this._client.delete(`/accounts/${account_id}/dlp/entries/${entryId}`, options) as Core.APIPromise<{
+        result: CustomDeleteResponse | null;
+      }>
+    )._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;
+
+  created_at: string;
+
+  enabled: boolean;
+
+  name: string;
+
+  pattern: ProfilesCustomAPI.Pattern;
+
+  updated_at: string;
+
+  profile_id?: string | null;
+}
+
+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 CustomListResponse {
+  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 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:
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  enabled: boolean;
+
+  /**
+   * Body param:
+   */
+  name: string;
+
+  /**
+   * Body param:
+   */
+  pattern: ProfilesCustomAPI.PatternParam;
+
+  /**
+   * Body param:
+   */
+  profile_id: string;
+}
+
+export interface CustomUpdateParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  enabled: boolean;
+
+  /**
+   * Body param:
+   */
+  name: string;
+
+  /**
+   * Body param:
+   */
+  pattern: ProfilesCustomAPI.PatternParam;
+}
+
+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,
+  };
+}