MailSlurp JS

Globals

MailSlurp JS

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Config

Ƭ Config: { apiKey: string ; attribution?: string ; basePath?: string ; fetchApi?: FetchAPI }

Defined in src/index.ts:40

MailSlurp config

remarks Obtain your API Key in your dashboard.

Type declaration:

NameType
apiKeystring
attribution?string
basePath?string
fetchApi?FetchAPI

GetMessagesOptions

Ƭ GetMessagesOptions: { limit?: number ; minCount?: number ; retryTimeout?: number ; since?: Date ; size?: number ; sort?: SortEnum }

Defined in src/index.ts:497

Options for advanced message fetching

remarks For more control over fetching. See also Webhook endpoints

Type declaration:

NameType
limit?number
minCount?number
retryTimeout?number
since?Date
size?number
sort?SortEnum

SortEnum

Ƭ SortEnum: "ASC" | "DESC"

Defined in src/index.ts:33

Variables

BASE_PATH

Const BASE_PATH: string = ‘https://api.mailslurp.com’.replace(//+$/, ‘')

Defined in src/generated/api.ts:19

Functions

AliasControllerApiFactory

ConstAliasControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:5053

AliasControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createAlias(createAliasOptions: CreateAliasOptions, options?: any) => Promise<AliasDto>
deleteAlias(aliasId: string, options?: any) => Promise<Response>
getAlias(aliasId: string, options?: any) => Promise<AliasDto>
getAliasEmails(aliasId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageEmailProjection>
getAliasThreads(aliasId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageThreadProjection>
getAliases(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageAlias>
replyToAliasEmail(aliasId: string, emailId: string, replyToAliasEmailOptions: ReplyToAliasEmailOptions, options?: any) => Promise<SentEmailDto>
sendAliasEmail(aliasId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<SentEmailDto>
updateAlias(aliasId: string, updateAliasOptions: UpdateAliasOptions, options?: any) => Promise<Response>

AliasControllerApiFetchParamCreator

ConstAliasControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:4100

AliasControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createAlias(createAliasOptions: CreateAliasOptions, options: any) => FetchArgs
deleteAlias(aliasId: string, options: any) => FetchArgs
getAlias(aliasId: string, options: any) => FetchArgs
getAliasEmails(aliasId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getAliasThreads(aliasId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getAliases(page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
replyToAliasEmail(aliasId: string, emailId: string, replyToAliasEmailOptions: ReplyToAliasEmailOptions, options: any) => FetchArgs
sendAliasEmail(aliasId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
updateAlias(aliasId: string, updateAliasOptions: UpdateAliasOptions, options: any) => FetchArgs

AliasControllerApiFp

ConstAliasControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:4739

AliasControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createAlias(createAliasOptions: CreateAliasOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AliasDto>
deleteAlias(aliasId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAlias(aliasId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AliasDto>
getAliasEmails(aliasId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageEmailProjection>
getAliasThreads(aliasId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageThreadProjection>
getAliases(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageAlias>
replyToAliasEmail(aliasId: string, emailId: string, replyToAliasEmailOptions: ReplyToAliasEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
sendAliasEmail(aliasId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
updateAlias(aliasId: string, updateAliasOptions: UpdateAliasOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>

AttachmentControllerApiFactory

ConstAttachmentControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:5792

AttachmentControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any) => Promise<string[]>
uploadAttachmentBytes(string?: string, byteArray?: string, filename?: string, options?: any) => Promise<string[]>
uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any) => Promise<string[]>

AttachmentControllerApiFetchParamCreator

ConstAttachmentControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:5434

AttachmentControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
uploadAttachment(uploadOptions: UploadAttachmentOptions, options: any) => FetchArgs
uploadAttachmentBytes(string?: string, byteArray?: string, filename?: string, options: any) => FetchArgs
uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options: any) => FetchArgs

AttachmentControllerApiFp

ConstAttachmentControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:5672

AttachmentControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string»
uploadAttachmentBytes(string?: string, byteArray?: string, filename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string»
uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string»

BulkActionsControllerApiFactory

ConstBulkActionsControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:6249

BulkActionsControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
bulkCreateInboxes(count: number, options?: any) => Promise<Inbox[]>
bulkDeleteInboxes(ids: Array<string>, options?: any) => Promise<Response>
bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any) => Promise<Response>

BulkActionsControllerApiFetchParamCreator

ConstBulkActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:5953

BulkActionsControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
bulkCreateInboxes(count: number, options: any) => FetchArgs
bulkDeleteInboxes(ids: Array<string>, options: any) => FetchArgs
bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options: any) => FetchArgs

BulkActionsControllerApiFp

ConstBulkActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:6148

BulkActionsControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
bulkCreateInboxes(count: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<Inbox»
bulkDeleteInboxes(ids: Array<string>, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>

CommonActionsControllerApiFactory

ConstCommonActionsControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:6772

CommonActionsControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createNewEmailAddress(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => Promise<Inbox>
createNewEmailAddress1(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => Promise<Inbox>
emptyInbox(inboxId: string, options?: any) => Promise<Response>
sendEmailSimple(emailOptions: SimpleSendEmailOptions, options?: any) => Promise<Response>

CommonActionsControllerApiFetchParamCreator

ConstCommonActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:6360

CommonActionsControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewEmailAddress(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options: any) => FetchArgs
createNewEmailAddress1(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options: any) => FetchArgs
emptyInbox(inboxId: string, options: any) => FetchArgs
sendEmailSimple(emailOptions: SimpleSendEmailOptions, options: any) => FetchArgs

CommonActionsControllerApiFp

ConstCommonActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:6623

CommonActionsControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewEmailAddress(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
createNewEmailAddress1(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
emptyInbox(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
sendEmailSimple(emailOptions: SimpleSendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>

ContactControllerApiFactory

ConstContactControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:7411

ContactControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createContact(createContactOptions: CreateContactOptions, options?: any) => Promise<ContactDto>
deleteContact(contactId: string, options?: any) => Promise<Response>
getAllContacts(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageContactProjection>
getContact(contactId: string, options?: any) => Promise<ContactDto>
getContacts(options?: any) => Promise<ContactProjection[]>

ContactControllerApiFetchParamCreator

ConstContactControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:6948

ContactControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createContact(createContactOptions: CreateContactOptions, options: any) => FetchArgs
deleteContact(contactId: string, options: any) => FetchArgs
getAllContacts(page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getContact(contactId: string, options: any) => FetchArgs
getContacts(options: any) => FetchArgs

ContactControllerApiFp

ConstContactControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:7244

ContactControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createContact(createContactOptions: CreateContactOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ContactDto>
deleteContact(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAllContacts(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageContactProjection>
getContact(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ContactDto>
getContacts(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<ContactProjection»

DomainControllerApiFactory

ConstDomainControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:7953

DomainControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createDomain(domainOptions: CreateDomainOptions, options?: any) => Promise<DomainDto>
deleteDomain(id: string, options?: any) => Promise<string[]>
getDomain(id: string, options?: any) => Promise<DomainDto>
getDomains(options?: any) => Promise<DomainPreview[]>

DomainControllerApiFetchParamCreator

ConstDomainControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:7594

DomainControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createDomain(domainOptions: CreateDomainOptions, options: any) => FetchArgs
deleteDomain(id: string, options: any) => FetchArgs
getDomain(id: string, options: any) => FetchArgs
getDomains(options: any) => FetchArgs

DomainControllerApiFp

ConstDomainControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:7823

DomainControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createDomain(domainOptions: CreateDomainOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
deleteDomain(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string»
getDomain(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
getDomains(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<DomainPreview»

EmailControllerApiFactory

ConstEmailControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:9858

EmailControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
deleteAllEmails(options?: any) => Promise<Response>
deleteEmail(emailId: string, options?: any) => Promise<Response>
downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options?: any) => Promise<string>
downloadAttachmentBase64(attachmentId: string, emailId: string, options?: any) => Promise<DownloadAttachmentDto>
forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any) => Promise<Response>
getAttachmentMetaData(attachmentId: string, emailId: string, options?: any) => Promise<AttachmentMetaData>
getAttachments(emailId: string, options?: any) => Promise<AttachmentMetaData[]>
getEmail(emailId: string, decode?: boolean, options?: any) => Promise<Email>
getEmailContentMatch(contentMatchOptions: ContentMatchOptions, emailId: string, options?: any) => Promise<EmailContentMatchResult>
getEmailHTML(emailId: string, decode?: boolean, options?: any) => Promise<string>
getEmailHTMLQuery(emailId: string, htmlSelector?: string, options?: any) => Promise<EmailTextLinesResult>
getEmailTextLines(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options?: any) => Promise<EmailTextLinesResult>
getEmailsPaginated(inboxId?: Array<string>, page?: number, size?: number, sort?: "ASC" | "DESC", unreadOnly?: boolean, options?: any) => Promise<PageEmailProjection>
getRawEmailContents(emailId: string, options?: any) => Promise<string>
getRawEmailJson(emailId: string, options?: any) => Promise<RawEmailJson>
getUnreadEmailCount(options?: any) => Promise<UnreadCount>
replyToEmail(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options?: any) => Promise<SentEmailDto>
validateEmail(emailId: string, options?: any) => Promise<ValidationDto>

EmailControllerApiFetchParamCreator

ConstEmailControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:8084

EmailControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
deleteAllEmails(options: any) => FetchArgs
deleteEmail(emailId: string, options: any) => FetchArgs
downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options: any) => FetchArgs
downloadAttachmentBase64(attachmentId: string, emailId: string, options: any) => FetchArgs
forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options: any) => FetchArgs
getAttachmentMetaData(attachmentId: string, emailId: string, options: any) => FetchArgs
getAttachments(emailId: string, options: any) => FetchArgs
getEmail(emailId: string, decode?: boolean, options: any) => FetchArgs
getEmailContentMatch(contentMatchOptions: ContentMatchOptions, emailId: string, options: any) => FetchArgs
getEmailHTML(emailId: string, decode?: boolean, options: any) => FetchArgs
getEmailHTMLQuery(emailId: string, htmlSelector?: string, options: any) => FetchArgs
getEmailTextLines(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options: any) => FetchArgs
getEmailsPaginated(inboxId?: Array<string>, page?: number, size?: number, sort?: "ASC" | "DESC", unreadOnly?: boolean, options: any) => FetchArgs
getRawEmailContents(emailId: string, options: any) => FetchArgs
getRawEmailJson(emailId: string, options: any) => FetchArgs
getUnreadEmailCount(options: any) => FetchArgs
replyToEmail(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options: any) => FetchArgs
validateEmail(emailId: string, options: any) => FetchArgs

EmailControllerApiFp

ConstEmailControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:9248

EmailControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
deleteAllEmails(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
deleteEmail(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>
downloadAttachmentBase64(attachmentId: string, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DownloadAttachmentDto>
forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAttachmentMetaData(attachmentId: string, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AttachmentMetaData>
getAttachments(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<AttachmentMetaData»
getEmail(emailId: string, decode?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
getEmailContentMatch(contentMatchOptions: ContentMatchOptions, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailContentMatchResult>
getEmailHTML(emailId: string, decode?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>
getEmailHTMLQuery(emailId: string, htmlSelector?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailTextLinesResult>
getEmailTextLines(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailTextLinesResult>
getEmailsPaginated(inboxId?: Array<string>, page?: number, size?: number, sort?: "ASC" | "DESC", unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageEmailProjection>
getRawEmailContents(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>
getRawEmailJson(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<RawEmailJson>
getUnreadEmailCount(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<UnreadCount>
replyToEmail(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
validateEmail(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ValidationDto>

ExpiredControllerApiFactory

ConstExpiredControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:10817

ExpiredControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
getExpiredInboxByInboxId(inboxId: string, options?: any) => Promise<ExpiredInboxDto>
getExpiredInboxRecord(expiredId: string, options?: any) => Promise<ExpiredInboxDto>
getExpiredInboxes(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageExpiredInboxRecordProjection>

ExpiredControllerApiFetchParamCreator

ConstExpiredControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10523

ExpiredControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getExpiredInboxByInboxId(inboxId: string, options: any) => FetchArgs
getExpiredInboxRecord(expiredId: string, options: any) => FetchArgs
getExpiredInboxes(page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs

ExpiredControllerApiFp

ConstExpiredControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:10711

ExpiredControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getExpiredInboxByInboxId(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ExpiredInboxDto>
getExpiredInboxRecord(expiredId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ExpiredInboxDto>
getExpiredInboxes(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageExpiredInboxRecordProjection>

FormControllerApiFactory

ConstFormControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:11108

FormControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options?: any) => Promise<string>

FormControllerApiFetchParamCreator

ConstFormControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10938

FormControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options: any) => FetchArgs

FormControllerApiFp

ConstFormControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:11048

FormControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>

GroupControllerApiFactory

ConstGroupControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:12088

GroupControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => Promise<GroupContactsDto>
createGroup(createGroupOptions: CreateGroupOptions, options?: any) => Promise<GroupDto>
deleteGroup(groupId: string, options?: any) => Promise<Response>
getAllGroups(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageGroupProjection>
getGroup(groupId: string, options?: any) => Promise<GroupDto>
getGroupWithContacts(groupId: string, options?: any) => Promise<GroupContactsDto>
getGroupWithContactsPaginated(groupId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageContactProjection>
getGroups(options?: any) => Promise<GroupProjection[]>
removeContactsFromGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => Promise<GroupContactsDto>

GroupControllerApiFetchParamCreator

ConstGroupControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:11199

GroupControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options: any) => FetchArgs
createGroup(createGroupOptions: CreateGroupOptions, options: any) => FetchArgs
deleteGroup(groupId: string, options: any) => FetchArgs
getAllGroups(page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getGroup(groupId: string, options: any) => FetchArgs
getGroupWithContacts(groupId: string, options: any) => FetchArgs
getGroupWithContactsPaginated(groupId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getGroups(options: any) => FetchArgs
removeContactsFromGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options: any) => FetchArgs

GroupControllerApiFp

ConstGroupControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:11784

GroupControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupContactsDto>
createGroup(createGroupOptions: CreateGroupOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupDto>
deleteGroup(groupId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAllGroups(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageGroupProjection>
getGroup(groupId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupDto>
getGroupWithContacts(groupId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupContactsDto>
getGroupWithContactsPaginated(groupId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageContactProjection>
getGroups(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<GroupProjection»
removeContactsFromGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupContactsDto>

InboxControllerApiFactory

ConstInboxControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:14015

InboxControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createInbox(description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, name?: string, tags?: Array<string>, useDomainPool?: boolean, options?: any) => Promise<Inbox>
createInboxWithOptions(createInboxDto: CreateInboxDto, options?: any) => Promise<Inbox>
deleteAllInboxes(options?: any) => Promise<Response>
deleteInbox(inboxId: string, options?: any) => Promise<Response>
getAllInboxes(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC" | "DESC", tag?: string, options?: any) => Promise<PageInboxProjection>
getEmails(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<EmailPreview[]>
getInbox(inboxId: string, options?: any) => Promise<Inbox>
getInboxEmailsPaginated(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageEmailPreview>
getInboxSentEmails(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageSentEmailProjection>
getInboxTags(options?: any) => Promise<string[]>
getInboxes(size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<Inbox[]>
sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<Response>
sendEmailAndConfirm(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<SentEmailDto>
setInboxFavourited(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options?: any) => Promise<Inbox>
updateInbox(inboxId: string, updateInboxOptions: UpdateInboxOptions, options?: any) => Promise<Inbox>

InboxControllerApiFetchParamCreator

ConstInboxControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:12423

InboxControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createInbox(description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, name?: string, tags?: Array<string>, useDomainPool?: boolean, options: any) => FetchArgs
createInboxWithOptions(createInboxDto: CreateInboxDto, options: any) => FetchArgs
deleteAllInboxes(options: any) => FetchArgs
deleteInbox(inboxId: string, options: any) => FetchArgs
getAllInboxes(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC" | "DESC", tag?: string, options: any) => FetchArgs
getEmails(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getInbox(inboxId: string, options: any) => FetchArgs
getInboxEmailsPaginated(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getInboxSentEmails(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getInboxTags(options: any) => FetchArgs
getInboxes(size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
sendEmailAndConfirm(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
setInboxFavourited(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options: any) => FetchArgs
updateInbox(inboxId: string, updateInboxOptions: UpdateInboxOptions, options: any) => FetchArgs

InboxControllerApiFp

ConstInboxControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:13474

InboxControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createInbox(description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, name?: string, tags?: Array<string>, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
createInboxWithOptions(createInboxDto: CreateInboxDto, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
deleteAllInboxes(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
deleteInbox(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAllInboxes(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC" | "DESC", tag?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageInboxProjection>
getEmails(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview»
getInbox(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
getInboxEmailsPaginated(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageEmailPreview>
getInboxSentEmails(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageSentEmailProjection>
getInboxTags(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string»
getInboxes(size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<Inbox»
sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
sendEmailAndConfirm(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
setInboxFavourited(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
updateInbox(inboxId: string, updateInboxOptions: UpdateInboxOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>

MailServerControllerApiFactory

ConstMailServerControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:15075

MailServerControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
describeMailServerDomain(describeOptions: DescribeDomainOptions, options?: any) => Promise<DescribeMailServerDomainResult>
getDnsLookup(dnsLookupOptions: DNSLookupOptions, options?: any) => Promise<DNSLookupResults>
getIpAddress(name: string, options?: any) => Promise<IPAddressResult>
verifyEmailAddress(verifyOptions: VerifyEmailAddressOptions, options?: any) => Promise<EmailVerificationResult>

MailServerControllerApiFetchParamCreator

ConstMailServerControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:14679

MailServerControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
describeMailServerDomain(describeOptions: DescribeDomainOptions, options: any) => FetchArgs
getDnsLookup(dnsLookupOptions: DNSLookupOptions, options: any) => FetchArgs
getIpAddress(name: string, options: any) => FetchArgs
verifyEmailAddress(verifyOptions: VerifyEmailAddressOptions, options: any) => FetchArgs

MailServerControllerApiFp

ConstMailServerControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:14938

MailServerControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
describeMailServerDomain(describeOptions: DescribeDomainOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DescribeMailServerDomainResult>
getDnsLookup(dnsLookupOptions: DNSLookupOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DNSLookupResults>
getIpAddress(name: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<IPAddressResult>
verifyEmailAddress(verifyOptions: VerifyEmailAddressOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailVerificationResult>

SentEmailsControllerApiFactory

ConstSentEmailsControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:15440

SentEmailsControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
getSentEmail(id: string, options?: any) => Promise<SentEmailDto>
getSentEmails(inboxId?: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageSentEmailProjection>

SentEmailsControllerApiFetchParamCreator

ConstSentEmailsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:15224

SentEmailsControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getSentEmail(id: string, options: any) => FetchArgs
getSentEmails(inboxId?: string, page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs

SentEmailsControllerApiFp

ConstSentEmailsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:15360

SentEmailsControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getSentEmail(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
getSentEmails(inboxId?: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageSentEmailProjection>

TemplateControllerApiFactory

ConstTemplateControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:16004

TemplateControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any) => Promise<TemplateDto>
deleteTemplate(templateId: string, options?: any) => Promise<Response>
getAllTemplates(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageTemplateProjection>
getTemplate(templateId: string, options?: any) => Promise<TemplateDto>
getTemplates(options?: any) => Promise<TemplateProjection[]>

TemplateControllerApiFetchParamCreator

ConstTemplateControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:15541

TemplateControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createTemplate(createTemplateOptions: CreateTemplateOptions, options: any) => FetchArgs
deleteTemplate(templateId: string, options: any) => FetchArgs
getAllTemplates(page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getTemplate(templateId: string, options: any) => FetchArgs
getTemplates(options: any) => FetchArgs

TemplateControllerApiFp

ConstTemplateControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:15837

TemplateControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TemplateDto>
deleteTemplate(templateId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAllTemplates(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageTemplateProjection>
getTemplate(templateId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TemplateDto>
getTemplates(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<TemplateProjection»

WaitForControllerApiFactory

ConstWaitForControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:16869

WaitForControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
waitFor(waitForConditions?: WaitForConditions, options?: any) => Promise<EmailPreview[]>
waitForEmailCount(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<EmailPreview[]>
waitForLatestEmail(inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>
waitForMatchingEmail(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<EmailPreview[]>
waitForMatchingFirstEmail(matchOptions: MatchOptions, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>
waitForNthEmail(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>

WaitForControllerApiFetchParamCreator

ConstWaitForControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:16186

WaitForControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
waitFor(waitForConditions?: WaitForConditions, options: any) => FetchArgs
waitForEmailCount(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
waitForLatestEmail(inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
waitForMatchingEmail(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
waitForMatchingFirstEmail(matchOptions: MatchOptions, inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
waitForNthEmail(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs

WaitForControllerApiFp

ConstWaitForControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:16628

WaitForControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
waitFor(waitForConditions?: WaitForConditions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview»
waitForEmailCount(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview»
waitForLatestEmail(inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
waitForMatchingEmail(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview»
waitForMatchingFirstEmail(matchOptions: MatchOptions, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
waitForNthEmail(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>

WebhookControllerApiFactory

ConstWebhookControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:17767

WebhookControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createWebhook(inboxId: string, webhookOptions: CreateWebhookOptions, options?: any) => Promise<WebhookDto>
deleteWebhook(inboxId: string, webhookId: string, options?: any) => Promise<Response>
getAllWebhooks(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => Promise<PageWebhookProjection>
getWebhook(webhookId: string, options?: any) => Promise<WebhookDto>
getWebhooks(inboxId: string, options?: any) => Promise<WebhookDto[]>
sendTestData(webhookId: string, options?: any) => Promise<WebhookTestResult>

WebhookControllerApiFetchParamCreator

ConstWebhookControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:17182

WebhookControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createWebhook(inboxId: string, webhookOptions: CreateWebhookOptions, options: any) => FetchArgs
deleteWebhook(inboxId: string, webhookId: string, options: any) => FetchArgs
getAllWebhooks(page?: number, size?: number, sort?: "ASC" | "DESC", options: any) => FetchArgs
getWebhook(webhookId: string, options: any) => FetchArgs
getWebhooks(inboxId: string, options: any) => FetchArgs
sendTestData(webhookId: string, options: any) => FetchArgs

WebhookControllerApiFp

ConstWebhookControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:17567

WebhookControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createWebhook(inboxId: string, webhookOptions: CreateWebhookOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookDto>
deleteWebhook(inboxId: string, webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
getAllWebhooks(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<PageWebhookProjection>
getWebhook(webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookDto>
getWebhooks(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<WebhookDto»
sendTestData(webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookTestResult>

wrapCall

wrapCall<T>(tag: String, fn: () => Promise<T>): Promise<T>

Defined in src/index.ts:514

Type parameters:

Name
T

Parameters:

NameType
tagString
fn() => Promise<T>

Returns: Promise<T>

Object literals

COLLECTION_FORMATS

Const COLLECTION_FORMATS: object

Defined in src/generated/api.ts:25

export

Properties:

NameTypeValue
csvstring“,”
pipesstring“|”
ssvstring" "
tsvstring" "

More