mailslurp-client
Version:
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.
143 lines (142 loc) • 4.69 kB
TypeScript
/**
* 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 { PageEntityAutomationItems, PageEntityEventItems, PageEntityFavouriteItems, UserInfoDto } from '../models';
export interface GetEntityAutomationsRequest {
page?: number;
size?: number;
sort?: GetEntityAutomationsSortEnum;
since?: Date;
before?: Date;
inboxId?: string;
phoneId?: string;
filter?: GetEntityAutomationsFilterEnum;
}
export interface GetEntityEventsRequest {
page?: number;
size?: number;
sort?: GetEntityEventsSortEnum;
since?: Date;
before?: Date;
inboxId?: string;
emailId?: string;
phoneId?: string;
smsId?: string;
attachmentId?: string;
filter?: GetEntityEventsFilterEnum;
}
export interface GetEntityFavoritesRequest {
page?: number;
size?: number;
sort?: GetEntityFavoritesSortEnum;
since?: Date;
before?: Date;
filter?: GetEntityFavoritesFilterEnum;
}
export interface GetJsonPropertyAsStringRequest {
property: string;
body: object | null;
}
/**
*
*/
export declare class UserControllerApi extends runtime.BaseAPI {
/**
*/
getEntityAutomationsRaw(requestParameters: GetEntityAutomationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageEntityAutomationItems>>;
/**
*/
getEntityAutomations(requestParameters: GetEntityAutomationsRequest, initOverrides?: RequestInit): Promise<PageEntityAutomationItems>;
/**
*/
getEntityEventsRaw(requestParameters: GetEntityEventsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageEntityEventItems>>;
/**
*/
getEntityEvents(requestParameters: GetEntityEventsRequest, initOverrides?: RequestInit): Promise<PageEntityEventItems>;
/**
*/
getEntityFavoritesRaw(requestParameters: GetEntityFavoritesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageEntityFavouriteItems>>;
/**
*/
getEntityFavorites(requestParameters: GetEntityFavoritesRequest, initOverrides?: RequestInit): Promise<PageEntityFavouriteItems>;
/**
* Utility function to extract properties from JSON objects in language where this is cumbersome.
*/
getJsonPropertyAsStringRaw(requestParameters: GetJsonPropertyAsStringRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
/**
* Utility function to extract properties from JSON objects in language where this is cumbersome.
*/
getJsonPropertyAsString(requestParameters: GetJsonPropertyAsStringRequest, initOverrides?: RequestInit): Promise<string>;
/**
* Get account information for your user
*/
getUserInfoRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserInfoDto>>;
/**
* Get account information for your user
*/
getUserInfo(initOverrides?: RequestInit): Promise<UserInfoDto>;
}
/**
* @export
* @enum {string}
*/
export declare enum GetEntityAutomationsSortEnum {
ASC = "ASC",
DESC = "DESC"
}
/**
* @export
* @enum {string}
*/
export declare enum GetEntityAutomationsFilterEnum {
FORWARDER = "INBOX_FORWARDER",
REPLIER = "INBOX_REPLIER",
RULESET = "INBOX_RULESET"
}
/**
* @export
* @enum {string}
*/
export declare enum GetEntityEventsSortEnum {
ASC = "ASC",
DESC = "DESC"
}
/**
* @export
* @enum {string}
*/
export declare enum GetEntityEventsFilterEnum {
WEBHOOK_EVENT = "WEBHOOK_EVENT",
INBOX_FORWARDER_EVENT = "INBOX_FORWARDER_EVENT",
INBOX_REPLIER_EVENT = "INBOX_REPLIER_EVENT",
INBOX_RULESET_EVENT = "INBOX_RULESET_EVENT",
ALIAS_EVENT = "ALIAS_EVENT"
}
/**
* @export
* @enum {string}
*/
export declare enum GetEntityFavoritesSortEnum {
ASC = "ASC",
DESC = "DESC"
}
/**
* @export
* @enum {string}
*/
export declare enum GetEntityFavoritesFilterEnum {
INBOX = "INBOX",
EMAIL = "EMAIL",
ATTACHMENT = "ATTACHMENT",
PHONE = "PHONE",
SMS = "SMS"
}