126 lines
3.9 KiB
TypeScript
126 lines
3.9 KiB
TypeScript
import { APIResource } from "../../resource.js";
|
|
import * as Core from "../../core.js";
|
|
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../pagination.js";
|
|
export declare class Addresses 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: AddressCreateParams, options?: Core.RequestOptions): Core.APIPromise<Address>;
|
|
/**
|
|
* Lists existing destination addresses.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* // Automatically fetches more pages as needed.
|
|
* for await (const address of client.emailRouting.addresses.list(
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* )) {
|
|
* // ...
|
|
* }
|
|
* ```
|
|
*/
|
|
list(params: AddressListParams, options?: Core.RequestOptions): Core.PagePromise<AddressesV4PagePaginationArray, Address>;
|
|
/**
|
|
* Deletes a specific destination address.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const address = await client.emailRouting.addresses.delete(
|
|
* 'ea95132c15732412d22c1476fa83f27a',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
delete(destinationAddressIdentifier: string, params: AddressDeleteParams, options?: Core.RequestOptions): Core.APIPromise<Address>;
|
|
/**
|
|
* Gets information for a specific destination email already created.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const address = await client.emailRouting.addresses.get(
|
|
* 'ea95132c15732412d22c1476fa83f27a',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
get(destinationAddressIdentifier: string, params: AddressGetParams, options?: Core.RequestOptions): Core.APIPromise<Address>;
|
|
}
|
|
export declare class AddressesV4PagePaginationArray extends V4PagePaginationArray<Address> {
|
|
}
|
|
export interface Address {
|
|
/**
|
|
* Destination address identifier.
|
|
*/
|
|
id?: string;
|
|
/**
|
|
* The date and time the destination address has been created.
|
|
*/
|
|
created?: string;
|
|
/**
|
|
* The contact email address of the user.
|
|
*/
|
|
email?: string;
|
|
/**
|
|
* The date and time the destination address was last modified.
|
|
*/
|
|
modified?: string;
|
|
/**
|
|
* @deprecated Destination address tag. (Deprecated, replaced by destination
|
|
* address identifier)
|
|
*/
|
|
tag?: string;
|
|
/**
|
|
* The date and time the destination address has been verified. Null means not
|
|
* verified yet.
|
|
*/
|
|
verified?: string;
|
|
}
|
|
export interface AddressCreateParams {
|
|
/**
|
|
* Path param: Identifier.
|
|
*/
|
|
account_id: string;
|
|
/**
|
|
* Body param: The contact email address of the user.
|
|
*/
|
|
email: string;
|
|
}
|
|
export interface AddressListParams extends V4PagePaginationArrayParams {
|
|
/**
|
|
* Path param: Identifier.
|
|
*/
|
|
account_id: string;
|
|
/**
|
|
* Query param: Sorts results in an ascending or descending order.
|
|
*/
|
|
direction?: 'asc' | 'desc';
|
|
/**
|
|
* Query param: Filter by verified destination addresses.
|
|
*/
|
|
verified?: true | false;
|
|
}
|
|
export interface AddressDeleteParams {
|
|
/**
|
|
* Identifier.
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export interface AddressGetParams {
|
|
/**
|
|
* Identifier.
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export declare namespace Addresses {
|
|
export { type Address as Address, AddressesV4PagePaginationArray as AddressesV4PagePaginationArray, type AddressCreateParams as AddressCreateParams, type AddressListParams as AddressListParams, type AddressDeleteParams as AddressDeleteParams, type AddressGetParams as AddressGetParams, };
|
|
}
|
|
//# sourceMappingURL=addresses.d.ts.map
|