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.
226 lines (225 loc) • 9.41 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 { CountDto, PageSentSmsProjection, PageSmsProjection, ReplyForSms, SentSmsDto, SmsDto, SmsReplyOptions, SmsSendOptions, UnreadCount } from '../models';
export interface DeleteSentSmsMessageRequest {
sentSmsId: string;
}
export interface DeleteSentSmsMessagesRequest {
phoneNumberId?: string;
}
export interface DeleteSmsMessageRequest {
smsId: string;
}
export interface DeleteSmsMessagesRequest {
phoneNumberId?: string;
}
export interface GetAllSmsMessagesRequest {
phoneNumber?: string;
page?: number;
size?: number;
sort?: GetAllSmsMessagesSortEnum;
since?: Date;
before?: Date;
search?: string;
favourite?: boolean;
}
export interface GetReplyForSmsMessageRequest {
smsId: string;
}
export interface GetSentSmsMessageRequest {
sentSmsId: string;
}
export interface GetSentSmsMessagesPaginatedRequest {
phoneNumber?: string;
page?: number;
size?: number;
sort?: GetSentSmsMessagesPaginatedSortEnum;
since?: Date;
before?: Date;
search?: string;
}
export interface GetSmsMessageRequest {
smsId: string;
}
export interface ReplyToSmsMessageRequest {
smsId: string;
smsReplyOptions: SmsReplyOptions;
}
export interface SendSmsRequest {
smsSendOptions: SmsSendOptions;
fromPhoneNumber?: string;
fromPhoneId?: string;
}
export interface SetSmsFavouritedRequest {
smsId: string;
favourited: boolean;
}
/**
*
*/
export declare class SmsControllerApi extends runtime.BaseAPI {
/**
* Delete a sent SMS message
* Delete sent SMS message.
*/
deleteSentSmsMessageRaw(requestParameters: DeleteSentSmsMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete a sent SMS message
* Delete sent SMS message.
*/
deleteSentSmsMessage(requestParameters: DeleteSentSmsMessageRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Delete all sent SMS messages or all messages for a given phone number
* Delete all sent SMS messages
*/
deleteSentSmsMessagesRaw(requestParameters: DeleteSentSmsMessagesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete all sent SMS messages or all messages for a given phone number
* Delete all sent SMS messages
*/
deleteSentSmsMessages(requestParameters: DeleteSentSmsMessagesRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Delete an SMS message
* Delete SMS message.
*/
deleteSmsMessageRaw(requestParameters: DeleteSmsMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete an SMS message
* Delete SMS message.
*/
deleteSmsMessage(requestParameters: DeleteSmsMessageRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Delete all SMS messages or all messages for a given phone number
* Delete all SMS messages
*/
deleteSmsMessagesRaw(requestParameters: DeleteSmsMessagesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete all SMS messages or all messages for a given phone number
* Delete all SMS messages
*/
deleteSmsMessages(requestParameters: DeleteSmsMessagesRequest, initOverrides?: RequestInit): Promise<void>;
/**
*/
getAllSmsMessagesRaw(requestParameters: GetAllSmsMessagesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageSmsProjection>>;
/**
*/
getAllSmsMessages(requestParameters: GetAllSmsMessagesRequest, initOverrides?: RequestInit): Promise<PageSmsProjection>;
/**
* Get reply for an SMS message.
* Get reply for an SMS message
*/
getReplyForSmsMessageRaw(requestParameters: GetReplyForSmsMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ReplyForSms>>;
/**
* Get reply for an SMS message.
* Get reply for an SMS message
*/
getReplyForSmsMessage(requestParameters: GetReplyForSmsMessageRequest, initOverrides?: RequestInit): Promise<ReplyForSms>;
/**
* Get number of sent SMS
* Get sent SMS count
*/
getSentSmsCountRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<CountDto>>;
/**
* Get number of sent SMS
* Get sent SMS count
*/
getSentSmsCount(initOverrides?: RequestInit): Promise<CountDto>;
/**
* Returns an SMS summary object with content.
* Get sent SMS content including body. Expects sent SMS to exist by ID.
*/
getSentSmsMessageRaw(requestParameters: GetSentSmsMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SentSmsDto>>;
/**
* Returns an SMS summary object with content.
* Get sent SMS content including body. Expects sent SMS to exist by ID.
*/
getSentSmsMessage(requestParameters: GetSentSmsMessageRequest, initOverrides?: RequestInit): Promise<SentSmsDto>;
/**
* By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages
* Get all SMS messages in all phone numbers in paginated form. .
*/
getSentSmsMessagesPaginatedRaw(requestParameters: GetSentSmsMessagesPaginatedRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PageSentSmsProjection>>;
/**
* By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages
* Get all SMS messages in all phone numbers in paginated form. .
*/
getSentSmsMessagesPaginated(requestParameters: GetSentSmsMessagesPaginatedRequest, initOverrides?: RequestInit): Promise<PageSentSmsProjection>;
/**
* Get number of SMS
* Get SMS count
*/
getSmsCountRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<CountDto>>;
/**
* Get number of SMS
* Get SMS count
*/
getSmsCount(initOverrides?: RequestInit): Promise<CountDto>;
/**
* Returns a SMS summary object with content.
* Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
*/
getSmsMessageRaw(requestParameters: GetSmsMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SmsDto>>;
/**
* Returns a SMS summary object with content.
* Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
*/
getSmsMessage(requestParameters: GetSmsMessageRequest, initOverrides?: RequestInit): Promise<SmsDto>;
/**
* Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response
* Get unread SMS count
*/
getUnreadSmsCountRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<UnreadCount>>;
/**
* Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response
* Get unread SMS count
*/
getUnreadSmsCount(initOverrides?: RequestInit): Promise<UnreadCount>;
/**
* Reply to an SMS message.
* Send a reply to a received SMS message. Replies are sent from the receiving number.
*/
replyToSmsMessageRaw(requestParameters: ReplyToSmsMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SentSmsDto>>;
/**
* Reply to an SMS message.
* Send a reply to a received SMS message. Replies are sent from the receiving number.
*/
replyToSmsMessage(requestParameters: ReplyToSmsMessageRequest, initOverrides?: RequestInit): Promise<SentSmsDto>;
/**
*/
sendSmsRaw(requestParameters: SendSmsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SentSmsDto>>;
/**
*/
sendSms(requestParameters: SendSmsRequest, initOverrides?: RequestInit): Promise<SentSmsDto>;
/**
*/
setSmsFavouritedRaw(requestParameters: SetSmsFavouritedRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SmsDto>>;
/**
*/
setSmsFavourited(requestParameters: SetSmsFavouritedRequest, initOverrides?: RequestInit): Promise<SmsDto>;
}
/**
* @export
* @enum {string}
*/
export declare enum GetAllSmsMessagesSortEnum {
ASC = "ASC",
DESC = "DESC"
}
/**
* @export
* @enum {string}
*/
export declare enum GetSentSmsMessagesPaginatedSortEnum {
ASC = "ASC",
DESC = "DESC"
}