cloudflare/resources/abuse-reports/submitted/emails.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import { PagePromise, V4PagePagination, type V4PagePaginationParams } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseEmails extends APIResource {
    static readonly _key: readonly ['abuseReports', 'submitted', 'emails'];
    /**
     * List successful emails sent to the submitter of a report submitted by the
     * account. Does not include emails sent to customers or hosts.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const emailListResponse of client.abuseReports.submitted.emails.list(
     *   'report_id',
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * )) {
     *   // ...
     * }
     * ```
     */
    list(reportID: string, params: EmailListParams, options?: RequestOptions): PagePromise<EmailListResponsesV4PagePagination, EmailListResponse>;
}
export declare class Emails extends BaseEmails {
}
export type EmailListResponsesV4PagePagination = V4PagePagination<EmailListResponse>;
export interface EmailListResponse {
    emails: Array<EmailListResponse.Email>;
}
export declare namespace EmailListResponse {
    /**
     * An email sent to the customer for an abuse report.
     */
    interface Email {
        /**
         * Unique identifier of the email.
         */
        id: string;
        /**
         * Body content of the email.
         */
        body: string;
        /**
         * Email address of the recipient.
         */
        recipient: string;
        /**
         * When the email was sent. Time in RFC 3339 format
         * (https://www.rfc-editor.org/rfc/rfc3339.html)
         */
        sent_at: string;
        /**
         * Subject line of the email.
         */
        subject: string;
    }
}
export interface EmailListParams extends V4PagePaginationParams {
    /**
     * Path param: Cloudflare Account ID
     */
    account_id: string;
}
export declare namespace Emails {
    export { type EmailListResponse as EmailListResponse, type EmailListResponsesV4PagePagination as EmailListResponsesV4PagePagination, type EmailListParams as EmailListParams, };
}
//# sourceMappingURL=emails.d.mts.map