cloudflare
Version:
The official TypeScript library for the Cloudflare API
100 lines • 3.94 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../core/resource.mjs";
import { V4PagePaginationArray } from "../../core/pagination.mjs";
import { path } from "../../internal/utils/path.mjs";
export var BaseAddresses = /* @__PURE__ */ (() => {
class BaseAddresses extends APIResource {
/**
* Create a destination address to forward your emails to. Destination addresses
* need to be verified before they can be used.
*
* @example
* ```ts
* const address = await client.emailRouting.addresses.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* email: 'user@example.com',
* });
* ```
*/
create(params, options) {
const { account_id, ...body } = params;
return this._client.post(path `/accounts/${account_id}/email/routing/addresses`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Lists destination addresses configured for Email Routing in an account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const address of client.emailRouting.addresses.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList(path `/accounts/${account_id}/email/routing/addresses`, (V4PagePaginationArray), { query, ...options });
}
/**
* Deletes a specific destination address.
*
* @example
* ```ts
* const address = await client.emailRouting.addresses.delete(
* 'ea95132c15732412d22c1476fa83f27a',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(destinationAddressIdentifier, params, options) {
const { account_id } = params;
return this._client.delete(path `/accounts/${account_id}/email/routing/addresses/${destinationAddressIdentifier}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Updates the status of a specific destination address.
*
* @example
* ```ts
* const address = await client.emailRouting.addresses.edit(
* 'ea95132c15732412d22c1476fa83f27a',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* status: 'verified',
* },
* );
* ```
*/
edit(destinationAddressIdentifier, params, options) {
const { account_id, ...body } = params;
return this._client.patch(path `/accounts/${account_id}/email/routing/addresses/${destinationAddressIdentifier}`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Gets information for a specific destination email already created.
*
* @example
* ```ts
* const address = await client.emailRouting.addresses.get(
* 'ea95132c15732412d22c1476fa83f27a',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(destinationAddressIdentifier, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/email/routing/addresses/${destinationAddressIdentifier}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseAddresses._key = Object.freeze([
'emailRouting',
'addresses',
]);
return BaseAddresses;
})();
export class Addresses extends BaseAddresses {
}
//# sourceMappingURL=addresses.mjs.map