openapi.api library

Classes

Alias
AliasControllerApi
AliasDto
AliasProjection
ApiClient
ApiKeyAuth
AttachmentControllerApi
AttachmentMetaData
Authentication
BasicAuthOptions
BulkActionsControllerApi
BulkSendEmailOptions
CommonActionsControllerApi
ContactControllerApi
ContactDto
ContactProjection
ContentMatchOptions
CreateAliasOptions
CreateContactOptions
CreateDomainOptions
CreateGroupOptions
CreateInboxDto
CreateTemplateOptions
CreateWebhookOptions
DescribeDomainOptions
DescribeMailServerDomainResult
DNSLookupOptions
DNSLookupOptionsRecordTypesEnum
DNSLookupOptionsRecordTypesEnumTypeTransformer
Transformation class that can encode an instance of DNSLookupOptionsRecordTypesEnum to String, and decode dynamic data back to DNSLookupOptionsRecordTypesEnum.
DNSLookupResult
DNSLookupResultRecordTypeEnum
DNSLookupResultRecordTypeEnumTypeTransformer
Transformation class that can encode an instance of DNSLookupResultRecordTypeEnum to String, and decode dynamic data back to DNSLookupResultRecordTypeEnum.
DNSLookupResults
DomainControllerApi
DomainDto
DomainNameRecord
DomainNameRecordRecordTypeEnum
DomainNameRecordRecordTypeEnumTypeTransformer
Transformation class that can encode an instance of DomainNameRecordRecordTypeEnum to String, and decode dynamic data back to DomainNameRecordRecordTypeEnum.
DomainPreview
DownloadAttachmentDto
Email
EmailAnalysis
EmailContentMatchResult
EmailControllerApi
EmailPreview
EmailProjection
EmailTextLinesResult
EmailVerificationResult
ExpirationDefaults
ExpiredControllerApi
ExpiredInboxDto
ExpiredInboxRecordProjection
FormControllerApi
ForwardEmailOptions
GroupContactsDto
GroupControllerApi
GroupDto
GroupProjection
HTMLValidationResult
HttpBasicAuth
HttpBearerAuth
Inbox
InboxControllerApi
InboxProjection
IPAddressResult
MailServerControllerApi
MatchOption
MatchOptionFieldEnum
The email property to match on. One of SUBJECT, TO, BCC, CC or FROM
MatchOptionFieldEnumTypeTransformer
Transformation class that can encode an instance of MatchOptionFieldEnum to String, and decode dynamic data back to MatchOptionFieldEnum.
MatchOptions
MatchOptionShouldEnum
What criteria to apply. CONTAIN or EQUAL. Note CONTAIN is recommended due to some SMTP servers adding new lines to fields and body content.
MatchOptionShouldEnumTypeTransformer
Transformation class that can encode an instance of MatchOptionShouldEnum to String, and decode dynamic data back to MatchOptionShouldEnum.
NameServerRecord
OAuth
OrganizationInboxProjection
Pageable
PageAlias
PageContactProjection
PageEmailPreview
PageEmailProjection
PageExpiredInboxRecordProjection
PageGroupProjection
PageInboxProjection
PageOrganizationInboxProjection
PageSentEmailProjection
PageTemplateProjection
PageThreadProjection
PageWebhookProjection
QueryParam
RawEmailJson
ReplyToAliasEmailOptions
ReplyToAliasEmailOptionsSendStrategyEnum
When to send the email. Typically immediately
ReplyToAliasEmailOptionsSendStrategyEnumTypeTransformer
Transformation class that can encode an instance of ReplyToAliasEmailOptionsSendStrategyEnum to String, and decode dynamic data back to ReplyToAliasEmailOptionsSendStrategyEnum.
ReplyToEmailOptions
ReplyToEmailOptionsSendStrategyEnum
When to send the email. Typically immediately
ReplyToEmailOptionsSendStrategyEnumTypeTransformer
Transformation class that can encode an instance of ReplyToEmailOptionsSendStrategyEnum to String, and decode dynamic data back to ReplyToEmailOptionsSendStrategyEnum.
SendEmailOptions
SendEmailOptionsSendStrategyEnum
Optional strategy to use when sending the email
SendEmailOptionsSendStrategyEnumTypeTransformer
Transformation class that can encode an instance of SendEmailOptionsSendStrategyEnum to String, and decode dynamic data back to SendEmailOptionsSendStrategyEnum.
SentEmailDto
SentEmailProjection
SentEmailsControllerApi
SetInboxFavouritedOptions
SimpleSendEmailOptions
Sort
TemplateControllerApi
TemplateDto
TemplateProjection
TemplateVariable
TemplateVariableVariableTypeEnum
TemplateVariableVariableTypeEnumTypeTransformer
Transformation class that can encode an instance of TemplateVariableVariableTypeEnum to String, and decode dynamic data back to TemplateVariableVariableTypeEnum.
ThreadProjection
UnreadCount
UpdateAliasOptions
UpdateDomainOptions
UpdateGroupContacts
UpdateInboxOptions
UploadAttachmentOptions
ValidationDto
ValidationMessage
VerifyEmailAddressOptions
WaitForConditions
WaitForConditionsCountTypeEnum
How should the found count be compared to the expected count.
WaitForConditionsCountTypeEnumTypeTransformer
Transformation class that can encode an instance of WaitForConditionsCountTypeEnum to String, and decode dynamic data back to WaitForConditionsCountTypeEnum.
WaitForConditionsSortDirectionEnum
Direction to sort matching emails by created time
WaitForConditionsSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of WaitForConditionsSortDirectionEnum to String, and decode dynamic data back to WaitForConditionsSortDirectionEnum.
WaitForControllerApi
WebhookControllerApi
WebhookDto
WebhookDtoMethodEnum
HTTP method that your server endpoint must listen for
WebhookDtoMethodEnumTypeTransformer
Transformation class that can encode an instance of WebhookDtoMethodEnum to String, and decode dynamic data back to WebhookDtoMethodEnum.
WebhookProjection
WebhookTestRequest
WebhookTestRequestMethodEnum
WebhookTestRequestMethodEnumTypeTransformer
Transformation class that can encode an instance of WebhookTestRequestMethodEnum to String, and decode dynamic data back to WebhookTestRequestMethodEnum.
WebhookTestResponse
WebhookTestResult

Properties

defaultApiClient ApiClient
read / write

Functions

parameterToString(dynamic value) String
Format the given parameter object into a String.

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException