mailslurp-client/dist/generated/apis/TemplateControllerApi.d.ts

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

/**
 * MailSlurp API
 * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
 *
 * The version of the OpenAPI document: 6.5.2
 * Contact: contact@mailslurp.dev
 *
 * 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 { CreateTemplateOptions, PageTemplateProjection, TemplateDto, TemplatePreview, TemplateProjection } from '../models';
export interface CreateTemplateRequest {
    createTemplateOptions: CreateTemplateOptions;
}
export interface DeleteTemplateRequest {
    templateId: string;
}
export interface GetAllTemplatesRequest {
    page?: number;
    size?: number;
    sort?: GetAllTemplatesSortEnum;
    since?: Date;
    before?: Date;
}
export interface GetTemplateRequest {
    templateId: string;
}
export interface GetTemplatePreviewHtmlRequest {
    templateId: string;
}
export interface GetTemplatePreviewJsonRequest {
    templateId: string;
}
export interface UpdateTemplateRequest {
    templateId: string;
    createTemplateOptions: CreateTemplateOptions;
}
/**
 *
 */
export declare class TemplateControllerApi extends runtime.BaseAPI {
    /**
     * Create an email template with variables for use with templated transactional emails.
     * Create a Template
     */
    createTemplateRaw(requestParameters: CreateTemplateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TemplateDto>>;
    /**
     * Create an email template with variables for use with templated transactional emails.
     * Create a Template
     */
    createTemplate(requestParameters: CreateTemplateRequest, initOverrides?: RequestInit): Promise<TemplateDto>;
    /**
     * Delete template
     * Delete email template
     */
    deleteTemplateRaw(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete template
     * Delete email template
     */
    deleteTemplate(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Get all templates in paginated format
     * List templates
     */
    getAllTemplatesRaw(requestParameters: GetAllTemplatesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageTemplateProjection>>;
    /**
     * Get all templates in paginated format
     * List templates
     */
    getAllTemplates(requestParameters: GetAllTemplatesRequest, initOverrides?: RequestInit): Promise<PageTemplateProjection>;
    /**
     * Get email template
     * Get template
     */
    getTemplateRaw(requestParameters: GetTemplateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TemplateDto>>;
    /**
     * Get email template
     * Get template
     */
    getTemplate(requestParameters: GetTemplateRequest, initOverrides?: RequestInit): Promise<TemplateDto>;
    /**
     * Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.
     * Get template preview HTML
     */
    getTemplatePreviewHtmlRaw(requestParameters: GetTemplatePreviewHtmlRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
    /**
     * Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.
     * Get template preview HTML
     */
    getTemplatePreviewHtml(requestParameters: GetTemplatePreviewHtmlRequest, initOverrides?: RequestInit): Promise<string>;
    /**
     * Get email template preview with passed template variables in JSON format. Pass template variables as query params.
     * Get template preview Json
     */
    getTemplatePreviewJsonRaw(requestParameters: GetTemplatePreviewJsonRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TemplatePreview>>;
    /**
     * Get email template preview with passed template variables in JSON format. Pass template variables as query params.
     * Get template preview Json
     */
    getTemplatePreviewJson(requestParameters: GetTemplatePreviewJsonRequest, initOverrides?: RequestInit): Promise<TemplatePreview>;
    /**
     * Get all templates
     * List templates
     */
    getTemplatesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<TemplateProjection>>>;
    /**
     * Get all templates
     * List templates
     */
    getTemplates(initOverrides?: RequestInit): Promise<Array<TemplateProjection>>;
    /**
     * Update email template
     * Update template
     */
    updateTemplateRaw(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TemplateDto>>;
    /**
     * Update email template
     * Update template
     */
    updateTemplate(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit): Promise<TemplateDto>;
}
/**
 * @export
 * @enum {string}
 */
export declare enum GetAllTemplatesSortEnum {
    ASC = "ASC",
    DESC = "DESC"
}