import { APIResource } from "../../../../core/resource.mjs"; import * as CustomAPI from "./custom.mjs"; import { BaseCustom, Custom, CustomCreateParams, CustomCreateResponse, CustomDeleteParams, CustomDeleteResponse, CustomGetParams, CustomGetResponse, CustomListParams, CustomListResponse, CustomListResponsesSinglePage, CustomUpdateParams, CustomUpdateResponse } from "./custom.mjs"; import * as IntegrationAPI from "./integration.mjs"; import { BaseIntegration, Integration, IntegrationCreateParams, IntegrationCreateResponse, IntegrationDeleteParams, IntegrationDeleteResponse, IntegrationGetParams, IntegrationGetResponse, IntegrationListParams, IntegrationListResponse, IntegrationListResponsesSinglePage, IntegrationUpdateParams, IntegrationUpdateResponse } from "./integration.mjs"; import * as PredefinedAPI from "./predefined.mjs"; import { BasePredefined, Predefined, PredefinedCreateParams, PredefinedCreateResponse, PredefinedDeleteParams, PredefinedDeleteResponse, PredefinedGetParams, PredefinedGetResponse, PredefinedListParams, PredefinedListResponse, PredefinedListResponsesSinglePage, PredefinedUpdateParams, PredefinedUpdateResponse } from "./predefined.mjs"; import * as ProfilesCustomAPI from "../profiles/custom.mjs"; import { APIPromise } from "../../../../core/api-promise.mjs"; import { PagePromise, SinglePage } from "../../../../core/pagination.mjs"; import { RequestOptions } from "../../../../internal/request-options.mjs"; export declare class BaseEntries extends APIResource { static readonly _key: readonly ['zeroTrust', 'dlp', 'entries']; /** * 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' }, * }); * ``` */ create(params: EntryCreateParams, options?: RequestOptions): APIPromise; /** * 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?: RequestOptions): APIPromise; /** * 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?: RequestOptions): PagePromise; /** * 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?: RequestOptions): APIPromise; /** * 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?: RequestOptions): APIPromise; } export declare class Entries extends BaseEntries { custom: CustomAPI.Custom; predefined: PredefinedAPI.Predefined; integration: IntegrationAPI.Integration; } export type EntryListResponsesSinglePage = SinglePage; export interface EntryCreateResponse { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; pattern: ProfilesCustomAPI.Pattern; updated_at: string; description?: string | null; /** * @deprecated */ profile_id?: string | null; } export type EntryUpdateResponse = EntryUpdateResponse.CustomEntry | EntryUpdateResponse.CustomPromptTopicEntry | EntryUpdateResponse.PredefinedEntry | EntryUpdateResponse.IntegrationEntry | EntryUpdateResponse.ExactDataEntry | EntryUpdateResponse.DocumentFingerprintEntry | EntryUpdateResponse.WordListEntry; export declare namespace EntryUpdateResponse { interface CustomEntry { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; pattern: ProfilesCustomAPI.Pattern; type: 'custom'; updated_at: string; description?: string | null; /** * @deprecated */ profile_id?: string | null; } interface CustomPromptTopicEntry { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; type: 'custom_prompt_topic'; updated_at: string; /** * The optional description of the custom prompt topic entry. */ description?: string | null; } interface PredefinedEntry { id: string; confidence: PredefinedEntry.Confidence; enabled: boolean; name: string; type: 'predefined'; /** * @deprecated */ profile_id?: string | null; /** * A Predefined AI prompt classification topic entry. */ variant?: PredefinedEntry.UnionMember0 | PredefinedEntry.UnionMember1; } namespace PredefinedEntry { 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; } /** * A Predefined AI prompt classification topic entry. */ interface UnionMember0 { topic_type: 'Intent' | 'Content'; type: 'PromptTopic'; /** * A customer-facing explanation of what this predefined AI prompt topic * represents. */ description?: string | null; } /** * A general predefined entry. */ interface UnionMember1 { type: 'General'; /** * A customer-facing explanation of what this predefined entry represents. */ description?: string | null; } } interface IntegrationEntry { id: string; created_at: string; enabled: boolean; name: string; type: 'integration'; updated_at: string; profile_id?: string | null; } 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; /** * The optional description of the exact data entry. */ description?: string | null; } interface DocumentFingerprintEntry { id: string; created_at: string; enabled: boolean; name: string; type: 'document_fingerprint'; updated_at: string; /** * The optional description of the document fingerprint entry. */ description?: string | null; } 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.UnionMember0 | EntryListResponse.UnionMember1 | EntryListResponse.UnionMember2 | EntryListResponse.UnionMember3 | EntryListResponse.UnionMember4 | EntryListResponse.UnionMember5 | EntryListResponse.UnionMember6; export declare namespace EntryListResponse { interface UnionMember0 { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; pattern: ProfilesCustomAPI.Pattern; type: 'custom'; updated_at: string; description?: string | null; /** * @deprecated */ profile_id?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } interface UnionMember1 { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; type: 'custom_prompt_topic'; updated_at: string; /** * The optional description of the custom prompt topic entry. */ description?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } interface UnionMember2 { id: string; confidence: UnionMember2.Confidence; enabled: boolean; name: string; type: 'predefined'; /** * @deprecated */ profile_id?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; /** * A Predefined AI prompt classification topic entry. */ variant?: UnionMember2.UnionMember0 | UnionMember2.UnionMember1; } namespace UnionMember2 { 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; } /** * A Predefined AI prompt classification topic entry. */ interface UnionMember0 { topic_type: 'Intent' | 'Content'; type: 'PromptTopic'; /** * A customer-facing explanation of what this predefined AI prompt topic * represents. */ description?: string | null; } /** * A general predefined entry. */ interface UnionMember1 { type: 'General'; /** * A customer-facing explanation of what this predefined entry represents. */ description?: string | null; } } interface UnionMember3 { id: string; created_at: string; enabled: boolean; name: string; type: 'integration'; updated_at: string; profile_id?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } interface UnionMember4 { 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; /** * The optional description of the exact data entry. */ description?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } interface UnionMember5 { id: string; created_at: string; enabled: boolean; name: string; type: 'document_fingerprint'; updated_at: string; /** * The optional description of the document fingerprint entry. */ description?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } interface UnionMember6 { id: string; created_at: string; enabled: boolean; name: string; type: 'word_list'; updated_at: string; word_list: unknown; profile_id?: string | null; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } } export type EntryDeleteResponse = unknown; export type EntryGetResponse = EntryGetResponse.UnionMember0 | EntryGetResponse.UnionMember1 | EntryGetResponse.UnionMember2 | EntryGetResponse.UnionMember3 | EntryGetResponse.UnionMember4 | EntryGetResponse.UnionMember5 | EntryGetResponse.UnionMember6; export declare namespace EntryGetResponse { interface UnionMember0 { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; pattern: ProfilesCustomAPI.Pattern; type: 'custom'; updated_at: string; description?: string | null; /** * @deprecated */ profile_id?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } namespace UnionMember0 { /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } } interface UnionMember1 { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; type: 'custom_prompt_topic'; updated_at: string; /** * The optional description of the custom prompt topic entry. */ description?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } namespace UnionMember1 { /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } } interface UnionMember2 { id: string; confidence: UnionMember2.Confidence; enabled: boolean; name: string; type: 'predefined'; /** * @deprecated */ profile_id?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; /** * A Predefined AI prompt classification topic entry. */ variant?: UnionMember2.UnionMember0 | UnionMember2.UnionMember1; } namespace UnionMember2 { 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; } /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } /** * A Predefined AI prompt classification topic entry. */ interface UnionMember0 { topic_type: 'Intent' | 'Content'; type: 'PromptTopic'; /** * A customer-facing explanation of what this predefined AI prompt topic * represents. */ description?: string | null; } /** * A general predefined entry. */ interface UnionMember1 { type: 'General'; /** * A customer-facing explanation of what this predefined entry represents. */ description?: string | null; } } interface UnionMember3 { id: string; created_at: string; enabled: boolean; name: string; type: 'integration'; updated_at: string; profile_id?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } namespace UnionMember3 { /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } } interface UnionMember4 { 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; /** * The optional description of the exact data entry. */ description?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } namespace UnionMember4 { /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } } interface UnionMember5 { id: string; created_at: string; enabled: boolean; name: string; type: 'document_fingerprint'; updated_at: string; /** * The optional description of the document fingerprint entry. */ description?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } namespace UnionMember5 { /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } } interface UnionMember6 { id: string; created_at: string; enabled: boolean; name: string; type: 'word_list'; updated_at: string; word_list: unknown; profile_id?: string | null; profiles?: Array; upload_status?: 'empty' | 'uploading' | 'pending' | 'processing' | 'failed' | 'complete'; } namespace UnionMember6 { /** * Computed entry field for a profile that an entry is shared into. */ interface Profile { id: string; name: string; } } } export interface EntryCreateParams { /** * Path param */ account_id: string; /** * Body param */ enabled: boolean; /** * Body param */ name: string; /** * Body param */ pattern: ProfilesCustomAPI.PatternParam; /** * Body param */ description?: string | null; /** * Body param */ profile_id?: string; } export type EntryUpdateParams = EntryUpdateParams.Variant0 | EntryUpdateParams.Variant1 | EntryUpdateParams.Variant2; export declare namespace EntryUpdateParams { interface Variant0 { /** * Path param */ account_id: string; /** * Body param */ name: string; /** * Body param */ pattern: ProfilesCustomAPI.PatternParam; /** * Body param */ type: 'custom'; /** * Body param */ description?: string | null; /** * Body param */ enabled?: boolean; } interface Variant1 { /** * Path param */ account_id: string; /** * Body param */ type: 'predefined'; /** * Body param */ enabled?: boolean; } 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; } 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, type 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, BaseCustom as BaseCustom, type CustomCreateResponse as CustomCreateResponse, type CustomUpdateResponse as CustomUpdateResponse, type CustomListResponse as CustomListResponse, type CustomDeleteResponse as CustomDeleteResponse, type CustomGetResponse as CustomGetResponse, type 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, BasePredefined as BasePredefined, type PredefinedCreateResponse as PredefinedCreateResponse, type PredefinedUpdateResponse as PredefinedUpdateResponse, type PredefinedListResponse as PredefinedListResponse, type PredefinedDeleteResponse as PredefinedDeleteResponse, type PredefinedGetResponse as PredefinedGetResponse, type 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, BaseIntegration as BaseIntegration, type IntegrationCreateResponse as IntegrationCreateResponse, type IntegrationUpdateResponse as IntegrationUpdateResponse, type IntegrationListResponse as IntegrationListResponse, type IntegrationDeleteResponse as IntegrationDeleteResponse, type IntegrationGetResponse as IntegrationGetResponse, type IntegrationListResponsesSinglePage as IntegrationListResponsesSinglePage, type IntegrationCreateParams as IntegrationCreateParams, type IntegrationUpdateParams as IntegrationUpdateParams, type IntegrationListParams as IntegrationListParams, type IntegrationDeleteParams as IntegrationDeleteParams, type IntegrationGetParams as IntegrationGetParams, }; } //# sourceMappingURL=entries.d.mts.map