cloudflare
Version:
The official TypeScript library for the Cloudflare API
111 lines • 3.04 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as CatchAllsAPI from 'cloudflare/resources/email-routing/rules/catch-alls';
export declare class CatchAlls extends APIResource {
/**
* Enable or disable catch-all routing rule, or change action to forward to
* specific destination address.
*/
update(zoneIdentifier: string, body: CatchAllUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CatchAllUpdateResponse>;
/**
* Get information on the default catch-all routing rule.
*/
get(zoneIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<CatchAllGetResponse>;
}
/**
* Action for the catch-all routing rule.
*/
export interface CatchAllAction {
/**
* Type of action for catch-all rule.
*/
type: 'drop' | 'forward' | 'worker';
value?: Array<string>;
}
/**
* Matcher for catch-all routing rule.
*/
export interface CatchAllMatcher {
/**
* Type of matcher. Default is 'all'.
*/
type: 'all';
}
export interface CatchAllUpdateResponse {
/**
* Routing rule identifier.
*/
id?: string;
/**
* List actions for the catch-all routing rule.
*/
actions?: Array<CatchAllAction>;
/**
* Routing rule status.
*/
enabled?: true | false;
/**
* List of matchers for the catch-all routing rule.
*/
matchers?: Array<CatchAllMatcher>;
/**
* Routing rule name.
*/
name?: string;
/**
* @deprecated: Routing rule tag. (Deprecated, replaced by routing rule identifier)
*/
tag?: string;
}
export interface CatchAllGetResponse {
/**
* Routing rule identifier.
*/
id?: string;
/**
* List actions for the catch-all routing rule.
*/
actions?: Array<CatchAllAction>;
/**
* Routing rule status.
*/
enabled?: true | false;
/**
* List of matchers for the catch-all routing rule.
*/
matchers?: Array<CatchAllMatcher>;
/**
* Routing rule name.
*/
name?: string;
/**
* @deprecated: Routing rule tag. (Deprecated, replaced by routing rule identifier)
*/
tag?: string;
}
export interface CatchAllUpdateParams {
/**
* List actions for the catch-all routing rule.
*/
actions: Array<CatchAllAction>;
/**
* List of matchers for the catch-all routing rule.
*/
matchers: Array<CatchAllMatcher>;
/**
* Routing rule status.
*/
enabled?: true | false;
/**
* Routing rule name.
*/
name?: string;
}
export declare namespace CatchAlls {
export import CatchAllAction = CatchAllsAPI.CatchAllAction;
export import CatchAllMatcher = CatchAllsAPI.CatchAllMatcher;
export import CatchAllUpdateResponse = CatchAllsAPI.CatchAllUpdateResponse;
export import CatchAllGetResponse = CatchAllsAPI.CatchAllGetResponse;
export import CatchAllUpdateParams = CatchAllsAPI.CatchAllUpdateParams;
}
//# sourceMappingURL=catch-alls.d.ts.map