import { APIResource } from "../../../../resource.js"; import * as Core from "../../../../core.js"; import * as CustomAPI from "../profiles/custom.js"; import { SinglePage } from "../../../../pagination.js"; export declare class Predefined extends APIResource { /** * Predefined entries can't be created, this will update an existing predefined * entry. This is needed for our generated terraform API. * * @example * ```ts * const predefined = * await client.zeroTrust.dlp.entries.predefined.create({ * account_id: 'account_id', * enabled: true, * entry_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * }); * ``` */ create(params: PredefinedCreateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Updates a DLP entry. * * @example * ```ts * const predefined = * await client.zeroTrust.dlp.entries.predefined.update( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id', enabled: true }, * ); * ``` */ update(entryId: string, params: PredefinedUpdateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Lists all DLP entries in an account. * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const predefinedListResponse of client.zeroTrust.dlp.entries.predefined.list( * { account_id: 'account_id' }, * )) { * // ... * } * ``` */ list(params: PredefinedListParams, options?: Core.RequestOptions): Core.PagePromise; /** * This is a no-op as predefined entires can't be deleted but is needed for our * generated terraform API. * * @example * ```ts * const predefined = * await client.zeroTrust.dlp.entries.predefined.delete( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id' }, * ); * ``` */ delete(entryId: string, params: PredefinedDeleteParams, options?: Core.RequestOptions): Core.APIPromise; /** * Fetches a DLP entry by ID. * * @example * ```ts * const predefined = * await client.zeroTrust.dlp.entries.predefined.get( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id' }, * ); * ``` */ get(entryId: string, params: PredefinedGetParams, options?: Core.RequestOptions): Core.APIPromise; } export declare class PredefinedListResponsesSinglePage extends SinglePage { } export interface PredefinedCreateResponse { id: string; confidence: PredefinedCreateResponse.Confidence; enabled: boolean; name: string; /** * @deprecated */ profile_id?: string | null; /** * A Predefined AI prompt classification topic entry. */ variant?: PredefinedCreateResponse.UnionMember0 | PredefinedCreateResponse.UnionMember1; } export declare namespace PredefinedCreateResponse { 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; } } export interface PredefinedUpdateResponse { id: string; confidence: PredefinedUpdateResponse.Confidence; enabled: boolean; name: string; /** * @deprecated */ profile_id?: string | null; /** * A Predefined AI prompt classification topic entry. */ variant?: PredefinedUpdateResponse.UnionMember0 | PredefinedUpdateResponse.UnionMember1; } export declare namespace PredefinedUpdateResponse { 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; } } export type PredefinedListResponse = PredefinedListResponse.UnionMember0 | PredefinedListResponse.UnionMember1 | PredefinedListResponse.UnionMember2 | PredefinedListResponse.UnionMember3 | PredefinedListResponse.UnionMember4 | PredefinedListResponse.UnionMember5 | PredefinedListResponse.UnionMember6; export declare namespace PredefinedListResponse { interface UnionMember0 { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; pattern: CustomAPI.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; 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; 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; 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 PredefinedDeleteResponse = unknown; export type PredefinedGetResponse = PredefinedGetResponse.UnionMember0 | PredefinedGetResponse.UnionMember1 | PredefinedGetResponse.UnionMember2 | PredefinedGetResponse.UnionMember3 | PredefinedGetResponse.UnionMember4 | PredefinedGetResponse.UnionMember5 | PredefinedGetResponse.UnionMember6; export declare namespace PredefinedGetResponse { interface UnionMember0 { id: string; created_at: string; /** * @deprecated */ enabled: boolean; name: string; pattern: CustomAPI.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; 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; 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; 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 PredefinedCreateParams { /** * Path param */ account_id: string; /** * Body param */ enabled: boolean; /** * Body param */ entry_id: string; /** * Body param: This field is not used as the owning profile. For predefined entries * it is already set to a predefined profile. */ profile_id?: string | null; } export interface PredefinedUpdateParams { /** * Path param */ account_id: string; /** * Body param */ enabled: boolean; } export interface PredefinedListParams { account_id: string; } export interface PredefinedDeleteParams { account_id: string; } export interface PredefinedGetParams { account_id: string; } export declare namespace Predefined { export { 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, }; } //# sourceMappingURL=predefined.d.ts.map