// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../../resource'; import * as Core from '../../../../core'; import { SinglePage } from '../../../../pagination'; export class Rules extends APIResource { /** * Creates a new DLP email scanning rule that defines what content patterns to * detect in email messages and what actions to take. * * @example * ```ts * const rule = await client.zeroTrust.dlp.email.rules.create({ * account_id: 'account_id', * action: { action: 'Block' }, * conditions: [ * { * operator: 'InList', * selector: 'Recipients', * value: ['string'], * }, * ], * enabled: true, * name: 'name', * }); * ``` */ create(params: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/dlp/email/rules`, { body, ...options }) as Core.APIPromise<{ result: RuleCreateResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Update email scanner rule * * @example * ```ts * const rule = await client.zeroTrust.dlp.email.rules.update( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { * account_id: 'account_id', * action: { action: 'Block' }, * conditions: [ * { * operator: 'InList', * selector: 'Recipients', * value: ['string'], * }, * ], * enabled: true, * name: 'name', * }, * ); * ``` */ update( ruleId: string, params: RuleUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.put(`/accounts/${account_id}/dlp/email/rules/${ruleId}`, { body, ...options, }) as Core.APIPromise<{ result: RuleUpdateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Lists all email scanner rules for an account. * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const ruleListResponse of client.zeroTrust.dlp.email.rules.list( * { account_id: 'account_id' }, * )) { * // ... * } * ``` */ list( params: RuleListParams, options?: Core.RequestOptions, ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/dlp/email/rules`, RuleListResponsesSinglePage, options, ); } /** * Removes a DLP email scanning rule. The rule will no longer be applied to email * messages. * * @example * ```ts * const rule = await client.zeroTrust.dlp.email.rules.delete( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id' }, * ); * ``` */ delete( ruleId: string, params: RuleDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.delete(`/accounts/${account_id}/dlp/email/rules/${ruleId}`, options) as Core.APIPromise<{ result: RuleDeleteResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Reorders DLP email scanning rules by updating their priority values. Higher * priority rules are evaluated first. * * @example * ```ts * const response = * await client.zeroTrust.dlp.email.rules.bulkEdit({ * account_id: 'account_id', * new_priorities: { foo: 0 }, * }); * ``` */ bulkEdit(params: RuleBulkEditParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.patch(`/accounts/${account_id}/dlp/email/rules`, { body, ...options }) as Core.APIPromise<{ result: RuleBulkEditResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Gets detailed configuration for a specific DLP email scanning rule, including * detection patterns and actions. * * @example * ```ts * const rule = await client.zeroTrust.dlp.email.rules.get( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: 'account_id' }, * ); * ``` */ get( ruleId: string, params: RuleGetParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.get(`/accounts/${account_id}/dlp/email/rules/${ruleId}`, options) as Core.APIPromise<{ result: RuleGetResponse; }> )._thenUnwrap((obj) => obj.result); } } export class RuleListResponsesSinglePage extends SinglePage {} export interface RuleCreateResponse { action: RuleCreateResponse.Action; /** * Triggered if all conditions match. */ conditions: Array; created_at: string; enabled: boolean; name: string; priority: number; rule_id: string; updated_at: string; description?: string | null; } export namespace RuleCreateResponse { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleUpdateResponse { action: RuleUpdateResponse.Action; /** * Triggered if all conditions match. */ conditions: Array; created_at: string; enabled: boolean; name: string; priority: number; rule_id: string; updated_at: string; description?: string | null; } export namespace RuleUpdateResponse { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleListResponse { action: RuleListResponse.Action; /** * Triggered if all conditions match. */ conditions: Array; created_at: string; enabled: boolean; name: string; priority: number; rule_id: string; updated_at: string; description?: string | null; } export namespace RuleListResponse { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleDeleteResponse { action: RuleDeleteResponse.Action; /** * Triggered if all conditions match. */ conditions: Array; created_at: string; enabled: boolean; name: string; priority: number; rule_id: string; updated_at: string; description?: string | null; } export namespace RuleDeleteResponse { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleBulkEditResponse { action: RuleBulkEditResponse.Action; /** * Triggered if all conditions match. */ conditions: Array; created_at: string; enabled: boolean; name: string; priority: number; rule_id: string; updated_at: string; description?: string | null; } export namespace RuleBulkEditResponse { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleGetResponse { action: RuleGetResponse.Action; /** * Triggered if all conditions match. */ conditions: Array; created_at: string; enabled: boolean; name: string; priority: number; rule_id: string; updated_at: string; description?: string | null; } export namespace RuleGetResponse { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleCreateParams { /** * Path param */ account_id: string; /** * Body param */ action: RuleCreateParams.Action; /** * Body param: Triggered if all conditions match. */ conditions: Array; /** * Body param */ enabled: boolean; /** * Body param */ name: string; /** * Body param */ description?: string | null; } export namespace RuleCreateParams { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleUpdateParams { /** * Path param */ account_id: string; /** * Body param */ action: RuleUpdateParams.Action; /** * Body param: Triggered if all conditions match. */ conditions: Array; /** * Body param */ enabled: boolean; /** * Body param */ name: string; /** * Body param */ description?: string | null; } export namespace RuleUpdateParams { export interface Action { action: 'Block'; message?: string | null; } export interface Condition { operator: 'InList' | 'NotInList' | 'MatchRegex' | 'NotMatchRegex'; selector: 'Recipients' | 'Sender' | 'DLPProfiles'; value: Array | string; } } export interface RuleListParams { account_id: string; } export interface RuleDeleteParams { account_id: string; } export interface RuleBulkEditParams { /** * Path param */ account_id: string; /** * Body param */ new_priorities: { [key: string]: number }; } export interface RuleGetParams { account_id: string; } Rules.RuleListResponsesSinglePage = RuleListResponsesSinglePage; export declare namespace Rules { export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleBulkEditResponse as RuleBulkEditResponse, type RuleGetResponse as RuleGetResponse, RuleListResponsesSinglePage as RuleListResponsesSinglePage, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleDeleteParams as RuleDeleteParams, type RuleBulkEditParams as RuleBulkEditParams, type RuleGetParams as RuleGetParams, }; }