cloudflare
Version:
The official TypeScript library for the Cloudflare API
690 lines • 28.4 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseBlockSenders extends APIResource {
static readonly _key: readonly ['emailSecurity', 'settings', 'blockSenders'];
/**
* Creates a new blocked sender pattern. Emails matching this pattern will be
* blocked from delivery. Patterns can be email addresses, domains, or IP
* addresses, and support regular expressions.
*
* @example
* ```ts
* const blockSender =
* await client.emailSecurity.settings.blockSenders.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* is_regex: false,
* pattern: 'test@example.com',
* pattern_type: 'EMAIL',
* });
* ```
*/
create(params: BlockSenderCreateParams, options?: RequestOptions): APIPromise<BlockSenderCreateResponse>;
/**
* Returns a paginated list of blocked email sender patterns. These patterns
* prevent emails from matching senders from being delivered. Supports filtering by
* pattern type and searching across patterns.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const blockSenderListResponse of client.emailSecurity.settings.blockSenders.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params: BlockSenderListParams, options?: RequestOptions): PagePromise<BlockSenderListResponsesV4PagePaginationArray, BlockSenderListResponse>;
/**
* Removes a blocked sender pattern. After deletion, emails from this sender will
* no longer be automatically blocked based on this rule.
*
* @example
* ```ts
* const blockSender =
* await client.emailSecurity.settings.blockSenders.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(patternID: string, params: BlockSenderDeleteParams, options?: RequestOptions): APIPromise<BlockSenderDeleteResponse>;
/**
* Executes multiple blocked sender operations atomically: delete, partially
* update, replace, and create blocked sender patterns in a single request. All
* four operation arrays (deletes, patches, puts, posts) are required and executed
* in order. Send empty arrays for unused operations.
*
* @example
* ```ts
* const response =
* await client.emailSecurity.settings.blockSenders.batch({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* deletes: [
* { id: 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415' },
* ],
* patches: [{}],
* posts: [
* {
* is_regex: false,
* pattern: 'test@example.com',
* pattern_type: 'EMAIL',
* },
* ],
* puts: [
* {
* is_regex: false,
* pattern: 'test@example.com',
* pattern_type: 'EMAIL',
* },
* ],
* });
* ```
*/
batch(params: BlockSenderBatchParams, options?: RequestOptions): APIPromise<BlockSenderBatchResponse>;
/**
* Updates an existing blocked sender pattern. Only provided fields will be
* modified. The pattern will continue blocking emails until deleted.
*
* @example
* ```ts
* const response =
* await client.emailSecurity.settings.blockSenders.edit(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
edit(patternID: string, params: BlockSenderEditParams, options?: RequestOptions): APIPromise<BlockSenderEditResponse>;
/**
* Retrieves details for a specific blocked sender pattern including its pattern
* type, value, and metadata.
*
* @example
* ```ts
* const blockSender =
* await client.emailSecurity.settings.blockSenders.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(patternID: string, params: BlockSenderGetParams, options?: RequestOptions): APIPromise<BlockSenderGetResponse>;
}
export declare class BlockSenders extends BaseBlockSenders {
}
export type BlockSenderListResponsesV4PagePaginationArray = V4PagePaginationArray<BlockSenderListResponse>;
/**
* A blocked sender pattern.
*/
export interface BlockSenderCreateResponse {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
/**
* A blocked sender pattern.
*/
export interface BlockSenderListResponse {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
export interface BlockSenderDeleteResponse {
/**
* Blocked sender pattern identifier.
*/
id: string;
}
export interface BlockSenderBatchResponse {
deletes?: Array<BlockSenderBatchResponse.Delete>;
patches?: Array<BlockSenderBatchResponse.Patch>;
posts?: Array<BlockSenderBatchResponse.Post>;
puts?: Array<BlockSenderBatchResponse.Put>;
}
export declare namespace BlockSenderBatchResponse {
interface Delete {
/**
* Blocked sender pattern identifier.
*/
id: string;
}
/**
* A blocked sender pattern.
*/
interface Patch {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
/**
* A blocked sender pattern.
*/
interface Post {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
/**
* A blocked sender pattern.
*/
interface Put {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
}
/**
* A blocked sender pattern.
*/
export interface BlockSenderEditResponse {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
/**
* A blocked sender pattern.
*/
export interface BlockSenderGetResponse {
/**
* Blocked sender pattern identifier.
*/
id?: string;
comments?: string | null;
created_at?: string;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* @deprecated Use `modified_at` instead.
*/
last_modified?: string;
modified_at?: string;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
export interface BlockSenderCreateParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Body param: Whether `pattern` is a regular expression instead of a literal
* value.
*/
is_regex: boolean;
/**
* Body param: The pattern value to match. The format depends on `pattern_type`: a
* valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for
* DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for
* IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or
* `2606:4700:4700::/48`); the API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
*/
pattern: string;
/**
* Body param: Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
/**
* Body param
*/
comments?: string | null;
}
export interface BlockSenderListParams extends V4PagePaginationArrayParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Query param: The sorting direction.
*/
direction?: 'asc' | 'desc';
/**
* Query param: Field to sort by.
*/
order?: 'pattern' | 'created_at';
/**
* Query param: Filter by pattern value.
*/
pattern?: string;
/**
* Query param: Filter by pattern type.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
/**
* Query param: Search term for filtering records. Behavior may change.
*/
search?: string;
}
export interface BlockSenderDeleteParams {
/**
* Account identifier tag.
*/
account_id: string;
}
export interface BlockSenderBatchParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Body param: IDs of the blocked sender patterns to delete.
*/
deletes: Array<BlockSenderBatchParams.Delete>;
/**
* Body param: Partial updates to apply — each entry carries the pattern's ID and
* only the fields to change.
*/
patches: Array<BlockSenderBatchParams.Patch>;
/**
* Body param: Blocked sender patterns to create.
*/
posts: Array<BlockSenderBatchParams.Post>;
/**
* Body param: Full replacements to apply — each entry carries the pattern's ID and
* every field of its new value.
*/
puts: Array<BlockSenderBatchParams.Put>;
}
export declare namespace BlockSenderBatchParams {
interface Delete {
/**
* Blocked sender pattern identifier.
*/
id: string;
}
/**
* A blocked sender pattern.
*/
interface Patch {
comments?: string | null;
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex?: boolean;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
/**
* Create a blocked sender pattern.
*/
interface Post {
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex: boolean;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
comments?: string | null;
}
/**
* A blocked sender pattern.
*/
interface Put {
/**
* Whether `pattern` is a regular expression instead of a literal value.
*/
is_regex: boolean;
/**
* The pattern value to match. The format depends on `pattern_type`: a valid email
* address for EMAIL (e.g. `user@example.com`), a valid domain name for DOMAIN
* (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g.
* `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or `2606:4700:4700::/48`); the
* API rejects private or unique-local, loopback, link-local, unspecified, and IPv4
* broadcast addresses, including their IPv4-mapped IPv6 equivalents.
*/
pattern: string;
/**
* Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
comments?: string | null;
}
}
export interface BlockSenderEditParams {
/**
* Path param: Account identifier tag.
*/
account_id: string;
/**
* Body param
*/
comments?: string | null;
/**
* Body param: Whether `pattern` is a regular expression instead of a literal
* value.
*/
is_regex?: boolean;
/**
* Body param: The pattern value to match. The format depends on `pattern_type`: a
* valid email address for EMAIL (e.g. `user@example.com`), a valid domain name for
* DOMAIN (e.g. `example.com`), or a plain IPv4 or IPv6 address or CIDR block for
* IP (e.g. `1.2.3.4`, `1.2.3.0/24`, `2606:4700:4700::1111`, or
* `2606:4700:4700::/48`); the API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
*/
pattern?: string;
/**
* Body param: Type of pattern matching.
*
* - EMAIL: matches a full email address (e.g. `user@example.com`)
* - DOMAIN: matches a domain name (e.g. `example.com`)
* - IP: matches a plain IPv4 or IPv6 address (e.g. `1.2.3.4` or
* `2606:4700:4700::1111`) or CIDR block (e.g. `1.2.3.0/24` or
* `2606:4700:4700::/48`). The API rejects private or unique-local, loopback,
* link-local, unspecified, and IPv4 broadcast addresses, including their
* IPv4-mapped IPv6 equivalents.
* - UNKNOWN: deprecated; you cannot use this when creating or updating policies,
* but it may appear on existing entries.
*/
pattern_type?: 'EMAIL' | 'DOMAIN' | 'IP' | 'UNKNOWN';
}
export interface BlockSenderGetParams {
/**
* Account identifier tag.
*/
account_id: string;
}
export declare namespace BlockSenders {
export { type BlockSenderCreateResponse as BlockSenderCreateResponse, type BlockSenderListResponse as BlockSenderListResponse, type BlockSenderDeleteResponse as BlockSenderDeleteResponse, type BlockSenderBatchResponse as BlockSenderBatchResponse, type BlockSenderEditResponse as BlockSenderEditResponse, type BlockSenderGetResponse as BlockSenderGetResponse, type BlockSenderListResponsesV4PagePaginationArray as BlockSenderListResponsesV4PagePaginationArray, type BlockSenderCreateParams as BlockSenderCreateParams, type BlockSenderListParams as BlockSenderListParams, type BlockSenderDeleteParams as BlockSenderDeleteParams, type BlockSenderBatchParams as BlockSenderBatchParams, type BlockSenderEditParams as BlockSenderEditParams, type BlockSenderGetParams as BlockSenderGetParams, };
}
//# sourceMappingURL=block-senders.d.mts.map