cloudflare
Version:
The official TypeScript library for the Cloudflare API
107 lines • 3.81 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../resource.mjs";
import * as CatchAllsAPI from "./catch-alls.mjs";
import { CatchAlls, } from "./catch-alls.mjs";
import { V4PagePaginationArray } from "../../../pagination.mjs";
export class Rules extends APIResource {
constructor() {
super(...arguments);
this.catchAlls = new CatchAllsAPI.CatchAlls(this._client);
}
/**
* Rules consist of a set of criteria for matching emails (such as an email being
* sent to a specific custom email address) plus a set of actions to take on the
* email (like forwarding it to a specific destination address).
*
* @example
* ```ts
* const emailRoutingRule =
* await client.emailRouting.rules.create({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* actions: [{ type: 'forward' }],
* matchers: [{ type: 'literal' }],
* });
* ```
*/
create(params, options) {
const { zone_id, ...body } = params;
return this._client.post(`/zones/${zone_id}/email/routing/rules`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Update actions and matches, or enable/disable specific routing rules.
*
* @example
* ```ts
* const emailRoutingRule =
* await client.emailRouting.rules.update(
* 'a7e6fb77503c41d8a7f3113c6918f10c',
* {
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* actions: [{ type: 'forward' }],
* matchers: [{ type: 'literal' }],
* },
* );
* ```
*/
update(ruleIdentifier, params, options) {
const { zone_id, ...body } = params;
return this._client.put(`/zones/${zone_id}/email/routing/rules/${ruleIdentifier}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Lists existing routing rules.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const emailRoutingRule of client.emailRouting.rules.list(
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { zone_id, ...query } = params;
return this._client.getAPIList(`/zones/${zone_id}/email/routing/rules`, EmailRoutingRulesV4PagePaginationArray, { query, ...options });
}
/**
* Delete a specific routing rule.
*
* @example
* ```ts
* const emailRoutingRule =
* await client.emailRouting.rules.delete(
* 'a7e6fb77503c41d8a7f3113c6918f10c',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(ruleIdentifier, params, options) {
const { zone_id } = params;
return this._client.delete(`/zones/${zone_id}/email/routing/rules/${ruleIdentifier}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Get information for a specific routing rule already created.
*
* @example
* ```ts
* const emailRoutingRule =
* await client.emailRouting.rules.get(
* 'a7e6fb77503c41d8a7f3113c6918f10c',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(ruleIdentifier, params, options) {
const { zone_id } = params;
return this._client.get(`/zones/${zone_id}/email/routing/rules/${ruleIdentifier}`, options)._thenUnwrap((obj) => obj.result);
}
}
export class EmailRoutingRulesV4PagePaginationArray extends V4PagePaginationArray {
}
Rules.EmailRoutingRulesV4PagePaginationArray = EmailRoutingRulesV4PagePaginationArray;
Rules.CatchAlls = CatchAlls;
//# sourceMappingURL=rules.mjs.map