import type * as Brevo from "../../../../index.js"; /** * @example * { * identifier: "4320f270-a4e3-4a2e-b591-edfe30a5e627", * startDate: "2022-02-02", * endDate: "2022-03-02" * } */ export interface GetScheduledEmailByIdRequest { /** The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored. */ identifier: string; /** Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date. */ startDate?: string; /** Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. */ endDate?: string; /** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid when identifier is `messageId`. */ sort?: Brevo.GetScheduledEmailByIdRequestSort; /** Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`. */ status?: Brevo.GetScheduledEmailByIdRequestStatus; /** Number of documents returned per page. Not valid when identifier is `messageId`. */ limit?: number; /** Index of the first document on the page. Not valid when identifier is `messageId`. */ offset?: number; }