// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../../core/resource'; import * as CustomAPI from '../profiles/custom'; import { APIPromise } from '../../../../core/api-promise'; import { PagePromise, SinglePage } from '../../../../core/pagination'; import { RequestOptions } from '../../../../internal/request-options'; import { path } from '../../../../internal/utils/path'; export class BaseIntegration extends APIResource { static override readonly _key: readonly ['zeroTrust', 'dlp', 'entries', 'integration'] = Object.freeze([ 'zeroTrust', 'dlp', 'entries', 'integration', ] as const); /** * Integration entries can't be created, this will update an existing integration * entry. This is needed for our generated terraform API. * * @example * ```ts * const integration = * await client.zeroTrust.dlp.entries.integration.create({ * account_id: 'account_id', * enabled: true, * entry_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * }); * ``` */ create(params: IntegrationCreateParams, options?: RequestOptions): APIPromise { const { account_id, ...body } = params; return ( this._client.post(path`/accounts/${account_id}/dlp/entries/integration`, { body, ...options, }) as APIPromise<{ result: IntegrationCreateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Updates a DLP entry. * * @example * ```ts * const integration = * await client.zeroTrust.dlp.entries.integration.update( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id', enabled: true }, * ); * ``` */ update( entryID: string, params: IntegrationUpdateParams, options?: RequestOptions, ): APIPromise { const { account_id, ...body } = params; return ( this._client.put(path`/accounts/${account_id}/dlp/entries/integration/${entryID}`, { body, ...options, }) as APIPromise<{ result: IntegrationUpdateResponse }> )._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?: RequestOptions, ): PagePromise { const { account_id } = params; return this._client.getAPIList( path`/accounts/${account_id}/dlp/entries`, SinglePage, options, ); } /** * This is a no-op as integration entires can't be deleted but is needed for our * generated terraform API. * * @example * ```ts * const integration = * await client.zeroTrust.dlp.entries.integration.delete( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id' }, * ); * ``` */ delete( entryID: string, params: IntegrationDeleteParams, options?: RequestOptions, ): APIPromise { const { account_id } = params; return ( this._client.delete( path`/accounts/${account_id}/dlp/entries/integration/${entryID}`, options, ) as 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?: RequestOptions, ): APIPromise { const { account_id } = params; return ( this._client.get(path`/accounts/${account_id}/dlp/entries/${entryID}`, options) as APIPromise<{ result: IntegrationGetResponse; }> )._thenUnwrap((obj) => obj.result); } } export class Integration extends BaseIntegration {} export type IntegrationListResponsesSinglePage = SinglePage; export interface IntegrationCreateResponse { id: string; created_at: string; enabled: boolean; name: string; updated_at: string; profile_id?: string | null; } export interface IntegrationUpdateResponse { id: string; created_at: string; enabled: boolean; name: string; updated_at: string; profile_id?: string | null; } export type IntegrationListResponse = | IntegrationListResponse.UnionMember0 | IntegrationListResponse.UnionMember1 | IntegrationListResponse.UnionMember2 | IntegrationListResponse.UnionMember3 | IntegrationListResponse.UnionMember4 | IntegrationListResponse.UnionMember5 | IntegrationListResponse.UnionMember6; export namespace IntegrationListResponse { export 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'; } export 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'; } export 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; } export namespace UnionMember2 { 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; } /** * A Predefined AI prompt classification topic entry. */ export 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. */ export interface UnionMember1 { type: 'General'; /** * A customer-facing explanation of what this predefined entry represents. */ description?: string | null; } } export 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'; } export 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'; } export 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'; } export 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 IntegrationDeleteResponse = unknown; export type IntegrationGetResponse = | IntegrationGetResponse.UnionMember0 | IntegrationGetResponse.UnionMember1 | IntegrationGetResponse.UnionMember2 | IntegrationGetResponse.UnionMember3 | IntegrationGetResponse.UnionMember4 | IntegrationGetResponse.UnionMember5 | IntegrationGetResponse.UnionMember6; export namespace IntegrationGetResponse { export 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'; } export namespace UnionMember0 { /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } } export 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'; } export namespace UnionMember1 { /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } } export 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; } export namespace UnionMember2 { 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; } /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } /** * A Predefined AI prompt classification topic entry. */ export 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. */ export interface UnionMember1 { type: 'General'; /** * A customer-facing explanation of what this predefined entry represents. */ description?: string | null; } } export 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'; } export namespace UnionMember3 { /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } } export 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'; } export namespace UnionMember4 { /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } } export 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'; } export namespace UnionMember5 { /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } } export 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'; } export namespace UnionMember6 { /** * Computed entry field for a profile that an entry is shared into. */ export interface Profile { id: string; name: string; } } } export interface IntegrationCreateParams { /** * 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 IntegrationUpdateParams { /** * Path param */ account_id: string; /** * Body param */ enabled: boolean; } export interface IntegrationListParams { account_id: string; } export interface IntegrationDeleteParams { account_id: string; } export interface IntegrationGetParams { account_id: string; } 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, type IntegrationListResponsesSinglePage as IntegrationListResponsesSinglePage, type IntegrationCreateParams as IntegrationCreateParams, type IntegrationUpdateParams as IntegrationUpdateParams, type IntegrationListParams as IntegrationListParams, type IntegrationDeleteParams as IntegrationDeleteParams, type IntegrationGetParams as IntegrationGetParams, }; }