/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateEmailRequestBody, EmailSchema, EmailsSchema, UpdateEmailRequestBody } from '../models/index'; export interface CreateEmailRequest { createEmailRequestBody: CreateEmailRequestBody; } export interface DeleteEmailRequest { emailId: string; permanentDelete?: DeleteEmailPermanentDeleteEnum; } export interface EmailOptionsRequest { emailId: string; } export interface ListEmailsRequest { filterStatus?: ListEmailsFilterStatusEnum; filterConversationId?: string; filterDirection?: ListEmailsFilterDirectionEnum; filterIds?: string; filterIsSystemSpam?: boolean; sort?: ListEmailsSortEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowEmailRequest { emailId: string; } export interface UpdateEmailRequest { emailId: string; updateEmailRequestBody: UpdateEmailRequestBody; } /** * */ export declare class EmailsApi extends runtime.BaseAPI { /** * Creates request options for createEmail without sending the request */ createEmailRequestOpts(requestParameters: CreateEmailRequest): Promise; /** * Creates a new email in your account. ### Email\'s Attributes Here is a table that describes the attributes of the email object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the email. | | `status` | string | The current status of the email (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the email was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the email was last modified (ISO 8601 format). | * Create Email */ createEmailRaw(requestParameters: CreateEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new email in your account. ### Email\'s Attributes Here is a table that describes the attributes of the email object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the email. | | `status` | string | The current status of the email (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the email was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the email was last modified (ISO 8601 format). | * Create Email */ createEmail(requestParameters: CreateEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteEmail without sending the request */ deleteEmailRequestOpts(requestParameters: DeleteEmailRequest): Promise; /** * Delete an email. Two modes: Soft delete (default): flips `status` to `trashed`, leaving the row in DynamoDB so it can be listed in the Trash folder and restored via a PATCH back to a non-trashed status. Use this from the regular Trash button in any folder. Permanent delete (`?permanentDelete=true`): removes the row from DynamoDB outright. Use this only from the Trash folder\'s \"Delete forever\" action; the row is unrecoverable. * Delete Email */ deleteEmailRaw(requestParameters: DeleteEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete an email. Two modes: Soft delete (default): flips `status` to `trashed`, leaving the row in DynamoDB so it can be listed in the Trash folder and restored via a PATCH back to a non-trashed status. Use this from the regular Trash button in any folder. Permanent delete (`?permanentDelete=true`): removes the row from DynamoDB outright. Use this only from the Trash folder\'s \"Delete forever\" action; the row is unrecoverable. * Delete Email */ deleteEmail(requestParameters: DeleteEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for emailOptions without sending the request */ emailOptionsRequestOpts(requestParameters: EmailOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Email Options */ emailOptionsRaw(requestParameters: EmailOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Email Options */ emailOptions(requestParameters: EmailOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for emailsOptions without sending the request */ emailsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Emails Options */ emailsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Emails Options */ emailsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listEmails without sending the request */ listEmailsRequestOpts(requestParameters: ListEmailsRequest): Promise; /** * Returns a collection of your account emails ## Overview Returns a collection of your account emails, sorted by the time they were inserted into the system in ascending order. ### Emails Endpoints Pagination The emails endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Emails */ listEmailsRaw(requestParameters: ListEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account emails ## Overview Returns a collection of your account emails, sorted by the time they were inserted into the system in ascending order. ### Emails Endpoints Pagination The emails endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Emails */ listEmails(requestParameters?: ListEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showEmail without sending the request */ showEmailRequestOpts(requestParameters: ShowEmailRequest): Promise; /** * This endpoint retrieves details of a specific email from your account. You can view information such as name, and other relevant attributes of the email. * Show Email */ showEmailRaw(requestParameters: ShowEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific email from your account. You can view information such as name, and other relevant attributes of the email. * Show Email */ showEmail(requestParameters: ShowEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateEmail without sending the request */ updateEmailRequestOpts(requestParameters: UpdateEmailRequest): Promise; /** * This endpoint allows you to update details of a specific email in your account. You can modify information such as name, and other relevant attributes of the email. Only the fields provided in the request will be updated. * Update Email */ updateEmailRaw(requestParameters: UpdateEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific email in your account. You can modify information such as name, and other relevant attributes of the email. Only the fields provided in the request will be updated. * Update Email */ updateEmail(requestParameters: UpdateEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const DeleteEmailPermanentDeleteEnum: { readonly True: "true"; readonly False: "false"; }; export type DeleteEmailPermanentDeleteEnum = typeof DeleteEmailPermanentDeleteEnum[keyof typeof DeleteEmailPermanentDeleteEnum]; /** * @export */ export declare const ListEmailsFilterStatusEnum: { readonly Draft: "draft"; readonly Scheduled: "scheduled"; readonly Sent: "sent"; readonly Suppressed: "suppressed"; readonly Archived: "archived"; readonly Trashed: "trashed"; readonly Failed: "failed"; readonly Pending: "pending"; }; export type ListEmailsFilterStatusEnum = typeof ListEmailsFilterStatusEnum[keyof typeof ListEmailsFilterStatusEnum]; /** * @export */ export declare const ListEmailsFilterDirectionEnum: { readonly Inbound: "inbound"; readonly Outbound: "outbound"; }; export type ListEmailsFilterDirectionEnum = typeof ListEmailsFilterDirectionEnum[keyof typeof ListEmailsFilterDirectionEnum]; /** * @export */ export declare const ListEmailsSortEnum: { readonly Created: "-created"; readonly Created2: "created"; readonly Modified: "-modified"; readonly Modified2: "modified"; }; export type ListEmailsSortEnum = typeof ListEmailsSortEnum[keyof typeof ListEmailsSortEnum]; //# sourceMappingURL=EmailsApi.d.ts.map