# External module: "generated/api"

# Variables

# Const BASE_PATH

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

Defined in src/generated/api.ts:19 (opens new window)

# Functions

# Const AliasControllerApiFactory

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

Defined in src/generated/api.ts:3258 (opens new window)

AliasControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • createAlias(createOwnedAliasOptions: CreateOwnedAliasOptions, options?: any): Promise‹Response›

  • createAnonymousAlias(createAnonymousAliasOptions: CreateAnonymousAliasOptions, options?: any): Promise‹Alias

  • deleteAlias(aliasId: string, options?: any): Promise‹Response›

  • getAlias(aliasId: string, options?: any): Promise‹Alias

  • getAliases(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): Promise‹PageAlias

  • updateAlias(aliasId: string, createOwnedAliasOptions: CreateOwnedAliasOptions, options?: any): Promise‹Response›


# Const AliasControllerApiFetchParamCreator

AliasControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:2665 (opens new window)

AliasControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object


# Const AliasControllerApiFp

AliasControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:3063 (opens new window)

AliasControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createAlias(createOwnedAliasOptions: CreateOwnedAliasOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • createAnonymousAlias(createAnonymousAliasOptions: CreateAnonymousAliasOptions, options?: any): function

  • deleteAlias(aliasId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAlias(aliasId: string, options?: any): function

  • getAliases(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): function

  • updateAlias(aliasId: string, createOwnedAliasOptions: CreateOwnedAliasOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›

# Const AttachmentControllerApiFactory

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

Defined in src/generated/api.ts:3743 (opens new window)

AttachmentControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any): Promise‹string[]›

  • uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any): Promise‹string[]›


# Const AttachmentControllerApiFetchParamCreator

AttachmentControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:3489 (opens new window)

AttachmentControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • uploadAttachment(uploadOptions: UploadAttachmentOptions, options: any): FetchArgs

  • uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options: any): FetchArgs


# Const AttachmentControllerApiFp

AttachmentControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:3657 (opens new window)

AttachmentControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Array‹string››
  • uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Array‹string››

# Const BulkActionsControllerApiFactory

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

Defined in src/generated/api.ts:4154 (opens new window)

BulkActionsControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • bulkCreateInboxes(count: number, options?: any): Promise‹Inbox[]›

  • bulkDeleteInboxes(ids: Array‹string›, options?: any): Promise‹Response›

  • bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any): Promise‹Response›


# Const BulkActionsControllerApiFetchParamCreator

BulkActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:3858 (opens new window)

BulkActionsControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object


# Const BulkActionsControllerApiFp

BulkActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:4053 (opens new window)

BulkActionsControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • bulkCreateInboxes(count: number, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Array‹Inbox››
  • bulkDeleteInboxes(ids: Array‹string›, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›

# Const CommonActionsControllerApiFactory

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

Defined in src/generated/api.ts:4539 (opens new window)

CommonActionsControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • createNewEmailAddress(options?: any): Promise‹Inbox

  • emptyInbox(inboxId: string, options?: any): Promise‹Response›

  • sendEmailSimple(sendEmailOptions: SendEmailOptions, options?: any): Promise‹Response›


# Const CommonActionsControllerApiFetchParamCreator

CommonActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:4265 (opens new window)

CommonActionsControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object


# Const CommonActionsControllerApiFp

CommonActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:4440 (opens new window)

CommonActionsControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createNewEmailAddress(options?: any): function

  • emptyInbox(inboxId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • sendEmailSimple(sendEmailOptions: SendEmailOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›

# Const ContactControllerApiFactory

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

Defined in src/generated/api.ts:5103 (opens new window)

ContactControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • 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[]›


# Const ContactControllerApiFetchParamCreator

ContactControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:4640 (opens new window)

ContactControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • 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


# Const ContactControllerApiFp

ContactControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:4936 (opens new window)

ContactControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createContact(createContactOptions: CreateContactOptions, options?: any): function

  • deleteContact(contactId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAllContacts(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): function

  • getContact(contactId: string, options?: any): function

  • getContacts(options?: any): function


# Const DomainControllerApiFactory

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

Defined in src/generated/api.ts:5645 (opens new window)

DomainControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • createDomain(domainOptions: CreateDomainOptions, options?: any): Promise‹DomainDto

  • deleteDomain(id: string, options?: any): Promise‹Response›

  • getDomain(id: string, options?: any): Promise‹DomainDto

  • getDomains(options?: any): Promise‹DomainPreview[]›


# Const DomainControllerApiFetchParamCreator

DomainControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:5286 (opens new window)

DomainControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object


# Const DomainControllerApiFp

DomainControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:5515 (opens new window)

DomainControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createDomain(domainOptions: CreateDomainOptions, options?: any): function

  • deleteDomain(id: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getDomain(id: string, options?: any): function

  • getDomains(options?: any): function


# Const EmailControllerApiFactory

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

Defined in src/generated/api.ts:7008 (opens new window)

EmailControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • deleteAllEmails(options?: any): Promise‹Response›

  • deleteEmail(emailId: string, options?: any): Promise‹Response›

  • downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options?: any): Promise‹string›

  • 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

  • getEmailHTML(emailId: string, decode?: boolean, options?: any): Promise‹string›

  • 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

  • validateEmail(emailId: string, options?: any): Promise‹ValidationDto


# Const EmailControllerApiFetchParamCreator

EmailControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:5776 (opens new window)

EmailControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • deleteAllEmails(options: any): FetchArgs

  • deleteEmail(emailId: string, options: any): FetchArgs

  • downloadAttachment(attachmentId: string, emailId: string, apiKey?: 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

  • getEmailHTML(emailId: string, decode?: boolean, 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

  • validateEmail(emailId: string, options: any): FetchArgs


# Const EmailControllerApiFp

EmailControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:6577 (opens new window)

EmailControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • deleteAllEmails(options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • deleteEmail(emailId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹string›
  • forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAttachmentMetaData(attachmentId: string, emailId: string, options?: any): function

  • getAttachments(emailId: string, options?: any): function

  • getEmail(emailId: string, decode?: boolean, options?: any): function

  • getEmailHTML(emailId: string, decode?: boolean, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹string›
  • getEmailsPaginated(inboxId?: Array‹string›, page?: number, size?: number, sort?: "ASC" | "DESC", unreadOnly?: boolean, options?: any): function

  • getRawEmailContents(emailId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹string›
  • getRawEmailJson(emailId: string, options?: any): function

  • getUnreadEmailCount(options?: any): function

  • validateEmail(emailId: string, options?: any): function


# Const FormControllerApiFactory

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

Defined in src/generated/api.ts:7645 (opens new window)

FormControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, toAlias?: string, otherParameters?: string, options?: any): Promise‹string›

# Const FormControllerApiFetchParamCreator

FormControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:7466 (opens new window)

FormControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, toAlias?: string, otherParameters?: string, options: any): FetchArgs

# Const FormControllerApiFp

FormControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:7582 (opens new window)

FormControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, toAlias?: string, otherParameters?: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹string›

# Const GroupControllerApiFactory

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

Defined in src/generated/api.ts:8516 (opens new window)

GroupControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object


# Const GroupControllerApiFetchParamCreator

GroupControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:7742 (opens new window)

GroupControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object


# Const GroupControllerApiFp

GroupControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:8251 (opens new window)

GroupControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any): function

  • createGroup(createGroupOptions: CreateGroupOptions, options?: any): function

  • deleteGroup(groupId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAllGroups(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): function

  • getGroup(groupId: string, options?: any): function

  • getGroupWithContacts(groupId: string, options?: any): function

  • getGroups(options?: any): function

  • removeContactsFromGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any): function


# Const InboxControllerApiFactory

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

Defined in src/generated/api.ts:10038 (opens new window)

InboxControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • createInbox(description?: string, emailAddress?: string, expiresAt?: Date, favourite?: boolean, name?: string, tags?: Array‹string›, 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, 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

  • getInboxTags(options?: any): Promise‹string[]›

  • getInboxes(options?: any): Promise‹Inbox[]›

  • sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any): Promise‹Response›

  • setInboxFavourited(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options?: any): Promise‹Inbox

  • updateInbox(inboxId: string, updateInboxOptions: UpdateInboxOptions, options?: any): Promise‹Inbox


# Const InboxControllerApiFetchParamCreator

InboxControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:8801 (opens new window)

InboxControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createInbox(description?: string, emailAddress?: string, expiresAt?: Date, favourite?: boolean, name?: string, tags?: Array‹string›, 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, 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

  • getInboxTags(options: any): FetchArgs

  • getInboxes(options: any): FetchArgs

  • sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any): FetchArgs

  • setInboxFavourited(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options: any): FetchArgs

  • updateInbox(inboxId: string, updateInboxOptions: UpdateInboxOptions, options: any): FetchArgs


# Const InboxControllerApiFp

InboxControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:9611 (opens new window)

InboxControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createInbox(description?: string, emailAddress?: string, expiresAt?: Date, favourite?: boolean, name?: string, tags?: Array‹string›, options?: any): function

  • deleteAllInboxes(options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • deleteInbox(inboxId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAllInboxes(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC" | "DESC", tag?: string, options?: any): function

  • getEmails(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, sort?: "ASC" | "DESC", options?: any): function

  • getInbox(inboxId: string, options?: any): function

  • getInboxEmailsPaginated(inboxId: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): function

  • getInboxTags(options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Array‹string››
  • getInboxes(options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Array‹Inbox››
  • sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • setInboxFavourited(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options?: any): function

  • updateInbox(inboxId: string, updateInboxOptions: UpdateInboxOptions, options?: any): function


# Const TemplateControllerApiFactory

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

Defined in src/generated/api.ts:11018 (opens new window)

TemplateControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • 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[]›


# Const TemplateControllerApiFetchParamCreator

TemplateControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10555 (opens new window)

TemplateControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • 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


# Const TemplateControllerApiFp

TemplateControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:10851 (opens new window)

TemplateControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any): function

  • deleteTemplate(templateId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAllTemplates(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): function

  • getTemplate(templateId: string, options?: any): function

  • getTemplates(options?: any): function


# Const WaitForControllerApiFactory

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

Defined in src/generated/api.ts:11759 (opens new window)

WaitForControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • 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[]›

  • waitForNthEmail(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options?: any): Promise‹Email


# Const WaitForControllerApiFetchParamCreator

WaitForControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:11200 (opens new window)

WaitForControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • 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

  • waitForNthEmail(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options: any): FetchArgs


# Const WaitForControllerApiFp

WaitForControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:11560 (opens new window)

WaitForControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • waitFor(waitForConditions?: WaitForConditions, options?: any): function

  • waitForEmailCount(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any): function

  • waitForLatestEmail(inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any): function

  • waitForMatchingEmail(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any): function

  • waitForNthEmail(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options?: any): function


# Const WebhookControllerApiFactory

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

Defined in src/generated/api.ts:12601 (opens new window)

WebhookControllerApi - factory interface

Parameters:

Name Type
configuration? Configuration
fetch? FetchAPI
basePath? string

Returns: object

  • 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


# Const WebhookControllerApiFetchParamCreator

WebhookControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:12016 (opens new window)

WebhookControllerApi - fetch parameter creator

Parameters:

Name Type
configuration? Configuration

Returns: object

  • 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


# Const WebhookControllerApiFp

WebhookControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:12401 (opens new window)

WebhookControllerApi - functional programming interface

Parameters:

Name Type
configuration? Configuration

Returns: object

  • createWebhook(inboxId: string, webhookOptions: CreateWebhookOptions, options?: any): function

  • deleteWebhook(inboxId: string, webhookId: string, options?: any): function

    • (fetch?: FetchAPI, basePath?: string): Promise‹Response›
  • getAllWebhooks(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): function

  • getWebhook(webhookId: string, options?: any): function

  • getWebhooks(inboxId: string, options?: any): function

  • sendTestData(webhookId: string, options?: any): function

# Object literals

# Const COLLECTION_FORMATS

#COLLECTION_FORMATS: object

Defined in src/generated/api.ts:25 (opens new window)

export

# csv

csv: string = ","

Defined in src/generated/api.ts:26 (opens new window)

# pipes

pipes: string = "|"

Defined in src/generated/api.ts:29 (opens new window)

# ssv

ssv: string = " "

Defined in src/generated/api.ts:27 (opens new window)

# tsv

tsv: string = " "

Defined in src/generated/api.ts:28 (opens new window)