Skip to content

Latest commit

 

History

History
3838 lines (2462 loc) · 99.7 KB

modules.md

File metadata and controls

3838 lines (2462 loc) · 99.7 KB
Raw

mailgun.js / Exports

mailgun.js

Table of contents

Namespaces

Classes

Interfaces

Type Aliases

Type Aliases

APIErrorOptions

Ƭ APIErrorOptions: Object

Type declaration

Name Type
body { error?: string ; message?: string }
body.error? string
body.message? string
headers? { [key: string]: unknown; }
message? string
status number
statusText? string
url? string

Defined in

Types/Common/Error.ts:1

APIErrorType

Ƭ APIErrorType: Object

Type declaration

Name Type
details string
message string
stack string
status number

Defined in

Types/Common/Error.ts:13

APIResponse

Ƭ APIResponse: Object

Type declaration

Name Type
body any
status number

Defined in

Types/Common/ApiResponse.ts:1

APIWebhook

Ƭ APIWebhook: Object

Type declaration

Name Type
url? string
urls? string[]

Defined in

Types/Webhooks/Webhooks.ts:1

AtLeastOneKeyPresent

Ƭ AtLeastOneKeyPresent<Object_, Keys>: Pick<Object_, Exclude<keyof Object_, Keys>> & { [K in Keys]-?: Required<Pick<Object_, K>> & Partial<Pick<Object_, Exclude<Keys, K>>> }[Keys]

Ensures the object has least one key present and not undefined

See

https://stackoverflow.com/a/49725198

Type parameters

Name Type
Object_ Object_
Keys extends keyof Object_ = keyof Object_

Defined in

Types/Messages/Messages.ts:7

BoolToString

Ƭ BoolToString: Object

Type declaration

Name Type
force_dkim_authority? DomainInfo["force_dkim_authority"]
wildcard? DomainUpdateInfo["wildcard"]

Defined in

Types/Domains/Domains.ts:32

BounceData

Ƭ BounceData: Object

Type declaration

Name Type
address string
code number
created_at string | Date
error string

Defined in

Types/Suppressions/Bounce.ts:2

CanceledMultipleValidationJob

Ƭ CanceledMultipleValidationJob: Object

Type declaration

Name Type
message string
status number

Defined in

Types/Validations/MultipleValidation.ts:91

ClickTrackingInfo

Ƭ ClickTrackingInfo: Object

Type declaration

Name Type
active "yes" | "no" | "true" | "false" | "htmlonly"

Defined in

Types/Domains/DomainTracking.ts:39

ComplaintData

Ƭ ComplaintData: Object

Type declaration

Name Type
address string
created_at string | Date

Defined in

Types/Suppressions/Complaint.ts:2

ConnectionSettings

Ƭ ConnectionSettings: Object

Type declaration

Name Type
require_tls boolean
skip_verification boolean

Defined in

Types/Domains/Domains.ts:98

ConnectionSettingsResponse

Ƭ ConnectionSettingsResponse: Object

Type declaration

Name Type
body { connection: ConnectionSettings }
body.connection ConnectionSettings
status number

Defined in

Types/Domains/Domains.ts:102

CreateDomainTemplateAPIResponse

Ƭ CreateDomainTemplateAPIResponse: Object

Type declaration

Name Type
body { message: string ; template: IDomainTemplate }
body.message string
body.template IDomainTemplate
status number

Defined in

Types/Domains/DomainTemplates.ts:60

CreateDomainTemplateVersionAPIResponse

Ƭ CreateDomainTemplateVersionAPIResponse: Object

Type declaration

Name Type
body { message: string ; template: IDomainTemplate }
body.message string
body.template IDomainTemplate
status number

Defined in

Types/Domains/DomainTemplates.ts:122

CreateDomainTemplateVersionResult

Ƭ CreateDomainTemplateVersionResult: Object

Type declaration

Name Type
message string
status number
template IDomainTemplate

Defined in

Types/Domains/DomainTemplates.ts:130

CreateUpdateList

Ƭ CreateUpdateList: Object

Type declaration

Name Type
access_level? "readonly" | "members" | "everyone"
address string
description? string
name? string
reply_preference? "list" | "sender"

Defined in

Types/MailingLists/MailingLists.ts:10

CreateUpdateMailListMembers

Ƭ CreateUpdateMailListMembers: Object

Type declaration

Name Type
address string
name? string
subscribed? "yes" | "no" | boolean
upsert? "yes" | "no"
vars? string

Defined in

Types/MailingLists/MailingListMembers.ts:29

CreateUpdateMailListMembersReq

Ƭ CreateUpdateMailListMembersReq: Object

Type declaration

Name Type
address string
name? string
subscribed? "yes" | "no" | boolean
upsert? "yes" | "no"
vars? string

Defined in

Types/MailingLists/MailingListMembers.ts:37

CreateUpdateRouteData

Ƭ CreateUpdateRouteData: Object

Type declaration

Name Type
action string[]
description? string
expression string
priority? number

Defined in

Types/Routes/Routes.ts:20

CreatedMultipleValidationJob

Ƭ CreatedMultipleValidationJob: Object

Type declaration

Name Type
id string
message string

Defined in

Types/Validations/MultipleValidation.ts:60

CreatedUpdatedDomainCredentialsResponse

Ƭ CreatedUpdatedDomainCredentialsResponse: Object

Type declaration

Name Type
body { message: string }
body.message string
status number

Defined in

Types/Domains/DomainCredentials.ts:36

CustomFile

Ƭ CustomFile: Object

Index signature

▪ [key: string]: unknown

Type declaration

Name Type
contentType? string
data CustomFileData
filename? string
knownLength? number

Defined in

Types/Messages/Messages.ts:19

CustomFileData

Ƭ CustomFileData: string | Blob | File | Buffer | NodeJS.ReadableStream

Defined in

Types/Messages/Messages.ts:17

DKIMAuthorityInfo

Ƭ DKIMAuthorityInfo: Object

Type declaration

Name Type
self boolean | "yes" | "no" | "true" | "false"

Defined in

Types/Domains/Domains.ts:120

DKIMSelectorInfo

Ƭ DKIMSelectorInfo: Object

Type declaration

Name Type
dkimSelector string

Defined in

Types/Domains/Domains.ts:135

DeletedDomainCredentialsResponse

Ƭ DeletedDomainCredentialsResponse: Object

Type declaration

Name Type
body { message: string ; spec: string }
body.message string
body.spec string
status number

Defined in

Types/Domains/DomainCredentials.ts:43

DeletedMember

Ƭ DeletedMember: Object

Type declaration

Name Type
member { address: string }
member.address string
message string

Defined in

Types/MailingLists/MailingListMembers.ts:45

DestroyRouteResponse

Ƭ DestroyRouteResponse: Object

Type declaration

Name Type
id string
message string

Defined in

Types/Routes/Routes.ts:15

DestroyedDomainResponse

Ƭ DestroyedDomainResponse: Object

Type declaration

Name Type
body MessageResponse
status number

Defined in

Types/Domains/Domains.ts:93

DestroyedList

Ƭ DestroyedList: Object

Type declaration

Name Type
address string
message string

Defined in

Types/MailingLists/MailingLists.ts:18

DeviceStatistic

Ƭ DeviceStatistic: Object

Type declaration

Name Type
clicked number
complained number
opened number
unique_clicked number
unique_opened number
unsubscribed number

Defined in

Types/Domains/DomainTags.ts:176

DevicesTypes

Ƭ DevicesTypes: Object

Type declaration

Name Type
desktop DeviceStatistic
mobile DeviceStatistic
tablet DeviceStatistic
unknown DeviceStatistic

Defined in

Types/Domains/DomainTags.ts:185

DomainCredentials

Ƭ DomainCredentials: Object

Type declaration

Name Type
login string
password string

Defined in

Types/Domains/DomainCredentials.ts:7

DomainCredentialsItem

Ƭ DomainCredentialsItem: Object

Type declaration

Name Type
created_at string
login string
mailbox string
size_bytes number | null

Defined in

Types/Domains/DomainCredentials.ts:12

DomainCredentialsList

Ƭ DomainCredentialsList: Object

Type declaration

Name Type
items DomainCredentialsItem[]
totalCount number

Defined in

Types/Domains/DomainCredentials.ts:26

DomainCredentialsQuery

Ƭ DomainCredentialsQuery: Object

Type declaration

Name Type
limit number
skip number

Defined in

Types/Domains/DomainCredentials.ts:2

DomainCredentialsResponseData

Ƭ DomainCredentialsResponseData: Object

Type declaration

Name Type
body { items: DomainCredentialsItem[] ; total_count: number }
body.items DomainCredentialsItem[]
body.total_count number
status number

Defined in

Types/Domains/DomainCredentials.ts:18

DomainCredentialsResult

Ƭ DomainCredentialsResult: Object

Type declaration

Name Type
message string
spec? string
status number

Defined in

Types/Domains/DomainCredentials.ts:30

DomainData

Ƭ DomainData: DomainShortData & { id: string ; is_disabled: boolean ; web_prefix: string ; web_scheme: string }

Defined in

Types/Domains/Domains.ts:50

DomainEvent

Ƭ DomainEvent: Object

Type declaration

Name Type
campaigns []
delivery-status { attempt-no: number ; certificate-verified: boolean ; code: number ; description: string ; message: string ; mx-host: string ; session-seconds: number ; tls: boolean ; utf8: boolean }
delivery-status.attempt-no number
delivery-status.certificate-verified boolean
delivery-status.code number
delivery-status.description string
delivery-status.message string
delivery-status.mx-host string
delivery-status.session-seconds number
delivery-status.tls boolean
delivery-status.utf8 boolean
envelope { sender: string ; sending-ip: string ; targets: string ; transport: string }
envelope.sender string
envelope.sending-ip string
envelope.targets string
envelope.transport string
event string
flags { is-authenticated: boolean ; is-routed: boolean ; is-system-test: boolean ; is-test-mode: boolean }
flags.is-authenticated boolean
flags.is-routed boolean
flags.is-system-test boolean
flags.is-test-mode boolean
id string
log-level string
message { attachments: [] ; headers: { from: string ; message-id: string ; subject: string ; to: string } ; size: 308 }
message.attachments []
message.headers { from: string ; message-id: string ; subject: string ; to: string }
message.headers.from string
message.headers.message-id string
message.headers.subject string
message.headers.to string
message.size 308
reason string
recipient string
recipient-domain string
severity string
storage { key: string ; url: string }
storage.key string
storage.url string
tags string[]
template? unknown
timestamp number
user-variables { [key: string]: unknown; }

Defined in

Types/Events/Events.ts:38

DomainInfo

Ƭ DomainInfo: DomainUpdateInfo & { dkim_key_size?: 1024 | 2048 ; force_dkim_authority?: boolean | "true" | "false" ; ips?: "" ; name: string ; pool_id?: "" ; smtp_password: string }

Defined in

Types/Domains/Domains.ts:19

DomainInfoReq

Ƭ DomainInfoReq: DomainInfo & { force_dkim_authority?: "true" | "false" }

Defined in

Types/Domains/Domains.ts:28

DomainListResponseData

Ƭ DomainListResponseData: Object

Type declaration

Name Type
body { items: DomainsListItem[] | null ; total_count: number }
body.items DomainsListItem[] | null
body.total_count number
status number

Defined in

Types/Domains/Domains.ts:81

DomainResponseData

Ƭ DomainResponseData: Object

Type declaration

Name Type
body { domain: DomainData ; message?: string ; receiving_dns_records: DNSRecord[] ; sending_dns_records: DNSRecord[] }
body.domain DomainData
body.message? string
body.receiving_dns_records DNSRecord[]
body.sending_dns_records DNSRecord[]
status number

Defined in

Types/Domains/Domains.ts:71

DomainShortData

Ƭ DomainShortData: Object

Type declaration

Name Type
created_at string
name string
require_tls boolean
skip_verification boolean
smtp_login string
smtp_password string
spam_action string
state string
type string
wildcard boolean

Defined in

Types/Domains/Domains.ts:37

DomainTagAPIResponseStatsItem

Ƭ DomainTagAPIResponseStatsItem: Object

Type declaration

Name Type
accepted? { incoming: number ; outgoing: number ; total: number }
accepted.incoming number
accepted.outgoing number
accepted.total number
clicked? { total: number }
clicked.total number
complained? { total: number }
complained.total number
delivered? { http: number ; optimized: number ; smtp: number ; total: number }
delivered.http number
delivered.optimized number
delivered.smtp number
delivered.total number
failed? { permanent: { bounce: number ; delayed-bounce: number ; optimized: number ; suppress-bounce: number ; suppress-complaint: number ; suppress-unsubscribe: number ; total: number ; webhook: number } ; temporary: { espblock: number ; total: number } }
failed.permanent { bounce: number ; delayed-bounce: number ; optimized: number ; suppress-bounce: number ; suppress-complaint: number ; suppress-unsubscribe: number ; total: number ; webhook: number }
failed.permanent.bounce number
failed.permanent.delayed-bounce number
failed.permanent.optimized number
failed.permanent.suppress-bounce number
failed.permanent.suppress-complaint number
failed.permanent.suppress-unsubscribe number
failed.permanent.total number
failed.permanent.webhook number
failed.temporary { espblock: number ; total: number }
failed.temporary.espblock number
failed.temporary.total number
opened? { total: number }
opened.total number
stored? { total: number }
stored.total number
time string
unsubscribed? { total: number }
unsubscribed.total number

Defined in

Types/Domains/DomainTags.ts:51

DomainTagCountriesAPIResponse

Ƭ DomainTagCountriesAPIResponse: Object

Type declaration

Name Type
body { country: { [key: string]: { clicked: number ; complained: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; } ; tag: string }
body.country { [key: string]: { clicked: number ; complained: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
body.tag string

Defined in

Types/Domains/DomainTags.ts:111

DomainTagCountriesAggregation

Ƭ DomainTagCountriesAggregation: Object

Type declaration

Name Type
country { [key: string]: { clicked: number ; complained: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
tag string

Defined in

Types/Domains/DomainTags.ts:127

DomainTagDevicesAPIResponse

Ƭ DomainTagDevicesAPIResponse: Object

Type declaration

Name Type
body { device: DevicesTypes ; tag: string }
body.device DevicesTypes
body.tag string
status number

Defined in

Types/Domains/DomainTags.ts:192

DomainTagDevicesAggregation

Ƭ DomainTagDevicesAggregation: Object

Type declaration

Name Type
device DevicesTypes
tag string

Defined in

Types/Domains/DomainTags.ts:200

DomainTagProvidersAPIResponse

Ƭ DomainTagProvidersAPIResponse: Object

Type declaration

Name Type
body { provider: { [key: string]: { accepted: number ; clicked: number ; complained: number ; delivered: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; } ; tag: string }
body.provider { [key: string]: { accepted: number ; clicked: number ; complained: number ; delivered: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
body.tag string
status number

Defined in

Types/Domains/DomainTags.ts:141

DomainTagProvidersAggregation

Ƭ DomainTagProvidersAggregation: Object

Type declaration

Name Type
provider { [key: string]: { accepted: number ; clicked: number ; complained: number ; delivered: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
tag string

Defined in

Types/Domains/DomainTags.ts:160

DomainTagStatAPIResponse

Ƭ DomainTagStatAPIResponse: Object

Type declaration

Name Type
body { description: string ; end: string ; resolution: Resolution ; start: string ; stats: DomainTagAPIResponseStatsItem[] ; tag: string }
body.description string
body.end string
body.resolution Resolution
body.start string
body.stats DomainTagAPIResponseStatsItem[]
body.tag string

Defined in

Types/Domains/DomainTags.ts:97

DomainTagStatisticItem

Ƭ DomainTagStatisticItem: Omit<DomainTagAPIResponseStatsItem, "time"> & { time: Date }

Defined in

Types/Domains/DomainTags.ts:107

DomainTagsItem

Ƭ DomainTagsItem: Object

Type declaration

Name Type
description string
first-seen Date
last-seen Date
tag string

Defined in

Types/Domains/DomainTags.ts:25

DomainTagsItemInfo

Ƭ DomainTagsItemInfo: Object

Type declaration

Name Type
description string
first-seen string
last-seen string
tag string

Defined in

Types/Domains/DomainTags.ts:18

DomainTagsList

Ƭ DomainTagsList: Object

Type declaration

Name Type
items DomainTagsItem[]
pages ParsedPagesList
status number

Defined in

Types/Domains/DomainTags.ts:40

DomainTagsMessageRes

Ƭ DomainTagsMessageRes: Object

Type declaration

Name Type
message string
status? number

Defined in

Types/Domains/DomainTags.ts:46

DomainTagsQuery

Ƭ DomainTagsQuery: Object

Type declaration

Name Type
limit number
page? string

Defined in

Types/Domains/DomainTags.ts:5

DomainTagsResponseData

Ƭ DomainTagsResponseData: Object

Type declaration

Name Type
body { items: DomainTagsItemInfo[] ; paging: PagesList }
body.items DomainTagsItemInfo[]
body.paging PagesList
status number

Defined in

Types/Domains/DomainTags.ts:32

DomainTagsStatisticQuery

Ƭ DomainTagsStatisticQuery: Object

Type declaration

Name Type
duration? string
end? number
event string
resolution? Resolution
start? number

Defined in

Types/Domains/DomainTags.ts:10

DomainTemplateData

Ƭ DomainTemplateData: Object

Type declaration

Name Type
comment? string
description string
engine? string
name string
tag? string
template string

Defined in

Types/Domains/DomainTemplates.ts:6

DomainTemplateUpdateData

Ƭ DomainTemplateUpdateData: Object

Type declaration

Name Type
description string

Defined in

Types/Domains/DomainTemplates.ts:23

DomainTemplateUpdateVersionData

Ƭ DomainTemplateUpdateVersionData: Object

Type declaration

Name Type
active? YesNo
comment? string
template? string

Defined in

Types/Domains/DomainTemplates.ts:27

DomainTemplateVersionData

Ƭ DomainTemplateVersionData: Object

Type declaration

Name Type
active? YesNo
comment? string
engine? string
tag string
template string

Defined in

Types/Domains/DomainTemplates.ts:15

DomainTemplatesQuery

Ƭ DomainTemplatesQuery: Object

Type declaration

Name Type Description
limit? number Number of records to retrieve. Default value is 10.
page? `?${string}` 'page' (optionally 'p') params from previous response's 'paging' object. Value must be stringified as query params. Ex: '?page=first','?page=next&p=name-of-last-item' ....

Defined in

Types/Domains/DomainTemplates.ts:33

DomainTrackingData

Ƭ DomainTrackingData: Object

Type declaration

Name Type
click { active: boolean }
click.active boolean
open { active: boolean }
open.active boolean
unsubscribe { active: boolean ; html_footer: string ; text_footer: string }
unsubscribe.active boolean
unsubscribe.html_footer string
unsubscribe.text_footer string

Defined in

Types/Domains/DomainTracking.ts:3

DomainTrackingResponse

Ƭ DomainTrackingResponse: Object

Type declaration

Name Type
body { tracking: DomainTrackingData }
body.tracking DomainTrackingData
status number

Defined in

Types/Domains/DomainTracking.ts:13

DomainUpdateInfo

Ƭ DomainUpdateInfo: Object

Type declaration

Name Type
spam_action? "disabled" | "block" | "tag"
web_scheme? "http" | "https"
wildcard? boolean | "true" | "false"

Defined in

Types/Domains/Domains.ts:9

DomainUpdateInfoReq

Ƭ DomainUpdateInfoReq: DomainUpdateInfo & { wildcard?: "true" | "false" }

Defined in

Types/Domains/Domains.ts:15

DomainsQuery

Ƭ DomainsQuery: Object

Type declaration

Name Type
authority? string
limit? number
skip? number
state? "active" | "unverified" | "disabled"

Defined in

Types/Domains/Domains.ts:2

EventsList

Ƭ EventsList: Object

Type declaration

Name Type
items DomainEvent[]
pages ParsedPagesList
status number

Defined in

Types/Events/Events.ts:92

EventsPage

Ƭ EventsPage: Object

Type declaration

Name Type
id string
number string
url string

Defined in

Types/Events/Events.ts:3

EventsQuery

Ƭ EventsQuery: FilterField & { ascending?: "yes" | "no" ; begin?: string ; end?: string ; limit?: number ; page?: string }

Defined in

Types/Events/Events.ts:24

EventsResponse

Ƭ EventsResponse: Object

Type declaration

Name Type
body { items: [] ; paging: PagesList }
body.items []
body.paging PagesList
status number

Defined in

Types/Events/Events.ts:31

FilterField

Ƭ FilterField: Object

Type declaration

Name Type
attachment? string
event? string
from? string
list? string
message-id? string
recipient? string
recipients? string
severity? string
size? string
subject? string
tags? string
to? string

Defined in

Types/Events/Events.ts:9

FormDataInput

Ƭ FormDataInput: Object

Index signature

▪ [key: string]: FormDataInputValue

Defined in

Types/Common/FormData.ts:16

FormDataInputValue

Ƭ FormDataInputValue: MimeMessage | CustomFileData | string | string[] | boolean | MessageAttachment | undefined | number | JsonObject

Defined in

Types/Messages/Messages.ts:36

FormDataOptions

Ƭ FormDataOptions: Object

Index signature

▪ [key: string]: NodeFormData

Defined in

Types/Common/FormData.ts:4

GetDomainTemplateAPIResponse

Ƭ GetDomainTemplateAPIResponse: Object

Type declaration

Name Type
body { template: IDomainTemplate }
body.template IDomainTemplate
status number

Defined in

Types/Domains/DomainTemplates.ts:87

IPsListQuery

Ƭ IPsListQuery: Object

Type declaration

Name Type
dedicated boolean | string

Defined in

Types/IPs/IPs.ts:14

InputFormData

Ƭ InputFormData: (form?: HTMLFormElement, submitter?: null | HTMLElement) => FormData | (options?: FormDataOptions) => FormData

Defined in

Types/Common/FormData.ts:8

IpData

Ƭ IpData: Object

Type declaration

Name Type
dedicated boolean
ip string
rdns string

Defined in

Types/IPs/IPs.ts:8

IpPool

Ƭ IpPool: Object

Type declaration

Name Type
description string
ips string[]
is_linked boolean
name string
pool_id string

Defined in

Types/IPPools/IpPools.ts:2

IpPoolCreateData

Ƭ IpPoolCreateData: Object

Type declaration

Name Type
description? string
ips? string[]
name string

Defined in

Types/IPPools/IpPools.ts:47

IpPoolCreateResponse

Ƭ IpPoolCreateResponse: Object

Type declaration

Name Type
body { message: string ; pool_id: string }
body.message string
body.pool_id string
status number

Defined in

Types/IPPools/IpPools.ts:53

IpPoolCreateResult

Ƭ IpPoolCreateResult: Object

Type declaration

Name Type
message string
pool_id string
status number

Defined in

Types/IPPools/IpPools.ts:61

IpPoolDeleteData

Ƭ IpPoolDeleteData: Object

Type declaration

Name Type
ip? string
pool_id? string

Defined in

Types/IPPools/IpPools.ts:42

IpPoolListResponse

Ƭ IpPoolListResponse: Object

Type declaration

Name Type
body { ip_pools: IpPool ; message: string }
body.ip_pools IpPool
body.message string
status number

Defined in

Types/IPPools/IpPools.ts:10

IpPoolListResult

Ƭ IpPoolListResult: Object

Type declaration

Name Type
ip_pools IpPool
message string
status number

Defined in

Types/IPPools/IpPools.ts:18

IpPoolMessageResponse

Ƭ IpPoolMessageResponse: Object

Type declaration

Name Type
body { message: string }
body.message string
status number

Defined in

Types/IPPools/IpPools.ts:30

IpPoolMessageResult

Ƭ IpPoolMessageResult: Object

Type declaration

Name Type
message string
status number

Defined in

Types/IPPools/IpPools.ts:37

IpPoolUpdateData

Ƭ IpPoolUpdateData: Object

Type declaration

Name Type
description string
ips string[]
name string

Defined in

Types/IPPools/IpPools.ts:24

IpsListResponseBody

Ƭ IpsListResponseBody: Object

Type declaration

Name Type
assignable_to_pools boolean
items string[]
total_count number

Defined in

Types/IPs/IPs.ts:2

Json

Ƭ Json: JsonPrimitive | JsonComposite

Defined in

Types/Messages/Messages.ts:51

JsonArray

Ƭ JsonArray: Json[]

Defined in

Types/Messages/Messages.ts:48

JsonComposite

Ƭ JsonComposite: JsonArray | JsonObject

Defined in

Types/Messages/Messages.ts:50

JsonObject

Ƭ JsonObject: Object

Index signature

▪ [key: string]: Json

Defined in

Types/Messages/Messages.ts:49

JsonPrimitive

Ƭ JsonPrimitive: string | number | boolean | null

Defined in

Types/Messages/Messages.ts:47

ListDomainTemplateVersionsAPIResponse

Ƭ ListDomainTemplateVersionsAPIResponse: Object

Type declaration

Name Type
body { paging: PagesList ; template: { createdAt: string ; createdBy: string ; description: string ; id: string ; name: string ; versions: ShortTemplateVersion[] } }
body.paging PagesList
body.template { createdAt: string ; createdBy: string ; description: string ; id: string ; name: string ; versions: ShortTemplateVersion[] }
body.template.createdAt string
body.template.createdBy string
body.template.description string
body.template.id string
body.template.name string
body.template.versions ShortTemplateVersion[]
status number

Defined in

Types/Domains/DomainTemplates.ts:158

ListDomainTemplateVersionsResult

Ƭ ListDomainTemplateVersionsResult: Object

Type declaration

Name Type
pages ParsedPagesList
template IDomainTemplate

Defined in

Types/Domains/DomainTemplates.ts:173

ListDomainTemplatesAPIResponse

Ƭ ListDomainTemplatesAPIResponse: Object

Type declaration

Name Type
body { items: IDomainTemplate[] ; paging: { first: string ; last: string ; next: string ; previous: string } }
body.items IDomainTemplate[]
body.paging { first: string ; last: string ; next: string ; previous: string }
body.paging.first string
body.paging.last string
body.paging.next string
body.paging.previous string
status number

Defined in

Types/Domains/DomainTemplates.ts:68

ListDomainTemplatesResult

Ƭ ListDomainTemplatesResult: Object

Type declaration

Name Type
items IDomainTemplate[]
pages ParsedPagesList
status number

Defined in

Types/Domains/DomainTemplates.ts:81

ListsQuery

Ƭ ListsQuery: Object

Type declaration

Name Type
address? string
limit? number
page? string

Defined in

Types/MailingLists/MailingLists.ts:4

MailListMember

Ƭ MailListMember: Object

Type declaration

Name Type
address string
name string
subscribed boolean
vars { [key: string]: unknown; }

Defined in

Types/MailingLists/MailingListMembers.ts:4

MailListMembersQuery

Ƭ MailListMembersQuery: Object

Type declaration

Name Type
limit? number
page? string
subscribed? "yes" | "no"

Defined in

Types/MailingLists/MailingListMembers.ts:13

MailListMembersResponse

Ƭ MailListMembersResponse: Object

Type declaration

Name Type
body { items: MailListMember[] ; paging: PagesList }
body.items MailListMember[]
body.paging PagesList
status number

Defined in

Types/MailingLists/MailingListMembers.ts:58

MailListMembersResult

Ƭ MailListMembersResult: Object

Type declaration

Name Type
items MailListMember[]
pages ParsedPagesList
status number

Defined in

Types/MailingLists/MailingListMembers.ts:66

MailgunClientOptions

Ƭ MailgunClientOptions: Object

Type declaration

Name Type
key string
proxy? AxiosProxyConfig
public_key? string
timeout? number
url? string
username string

Defined in

Types/MailgunClient/MailgunClientOptions.ts:3

MailgunMessageContent

Ƭ MailgunMessageContent: AtLeastOneKeyPresent<{ html?: string ; message?: MimeMessage ; template?: string ; text?: string }>

Defined in

Types/Messages/Messages.ts:53

MailgunMessageData

Ƭ MailgunMessageData: MailgunMessageContent & { [key: string]: FormDataInputValue; amp-html?: string ; attachment?: MessageAttachment ; bcc?: string | string[] ; cc?: string | string[] ; from?: string ; h:X-My-Header?: string ; inline?: any ; o:deliverytime?: string ; o:deliverytime-optimize-period?: string ; o:dkim?: boolean | "yes" | "no" ; o:require-tls?: boolean | "yes" | "no" ; o:skip-verification?: boolean | "yes" | "no" ; o:tag?: string | string[] ; o:testmode?: boolean | "yes" | "no" ; o:time-zone-localize?: string ; o:tracking?: boolean | "yes" | "no" ; o:tracking-clicks?: boolean | "yes" | "no" | "htmlonly" ; o:tracking-opens?: boolean | "yes" | "no" ; recipient-variables?: string ; subject?: string ; t:text?: boolean | "yes" | "no" ; t:variables?: string | JsonObject ; t:version?: string ; to?: string | string[] ; v:my-var?: string }

Defined in

Types/Messages/Messages.ts:73

MailingList

Ƭ MailingList: Object

Type declaration

Name Type
access_level string
address string
created_at string
description string
members_count number
name string
reply_preference null | string

Defined in

Types/MailingLists/MailingLists.ts:69

MailingListApiResponse

Ƭ MailingListApiResponse: Object

Type declaration

Name Type
body { items: MailingList[] ; paging: PagesList }
body.items MailingList[]
body.paging PagesList
status number

Defined in

Types/MailingLists/MailingLists.ts:85

MailingListCancelValidationResult

Ƭ MailingListCancelValidationResult: Object

Type declaration

Name Type
message string
status number

Defined in

Types/MailingLists/MailingLists.ts:65

MailingListResult

Ƭ MailingListResult: Object

Type declaration

Name Type
items MailingList[]
pages ParsedPagesList
status number

Defined in

Types/MailingLists/MailingLists.ts:79

MailingListValidationApiResponse

Ƭ MailingListValidationApiResponse: MailingListValidationResponse & { created_at: number }

Defined in

Types/MailingLists/MailingLists.ts:54

MailingListValidationResponse

Ƭ MailingListValidationResponse: Object

Type declaration

Name Type
download_url { csv: string ; json: string }
download_url.csv string
download_url.json string
id string
quantity number
records_processed number
status string
summary { result: { catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number } ; risk: { high: number ; low: number ; medium: number ; unknown: number } }
summary.result { catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number }
summary.result.catch_all number
summary.result.deliverable number
summary.result.do_not_send number
summary.result.undeliverable number
summary.result.unknown number
summary.risk { high: number ; low: number ; medium: number ; unknown: number }
summary.risk.high number
summary.risk.low number
summary.risk.medium number
summary.risk.unknown number

Defined in

Types/MailingLists/MailingLists.ts:29

MailingListValidationResult

Ƭ MailingListValidationResult: Object

Type declaration

Name Type
status number
validationResult MailingListValidationResultData

Defined in

Types/MailingLists/MailingLists.ts:60

MailingListValidationResultData

Ƭ MailingListValidationResultData: MailingListValidationResponse & { created_at: Date }

Defined in

Types/MailingLists/MailingLists.ts:57

MessageAttachment

Ƭ MessageAttachment: CustomFile | CustomFile[] | File | File[] | string | CustomFileData | CustomFileData[]

Defined in

Types/Messages/Messages.ts:27

MessageResponse

Ƭ MessageResponse: Object

Type declaration

Name Type
message string

Defined in

Types/Domains/Domains.ts:89

MessagesSendAPIResponse

Ƭ MessagesSendAPIResponse: Object

Type declaration

Name Type
body { id: string ; message: string }
body.id string
body.message string
status number

Defined in

Types/Messages/Messages.ts:244

MessagesSendResult

Ƭ MessagesSendResult: Object

Type declaration

Name Type
details? string
id? string
message? string
status number

Defined in

Types/Messages/Messages.ts:252

MimeMessage

Ƭ MimeMessage: string | Blob | Buffer | NodeJS.ReadableStream

Defined in

Types/Messages/Messages.ts:16

MultipleMembersData

Ƭ MultipleMembersData: Object

Type declaration

Name Type
members MailListMember[]
upsert "yes" | "no"

Defined in

Types/MailingLists/MailingListMembers.ts:19

MultipleMembersReqData

Ƭ MultipleMembersReqData: Object

Type declaration

Name Type
members string
upsert "yes" | "no"

Defined in

Types/MailingLists/MailingListMembers.ts:24

MultipleValidationCreationData

Ƭ MultipleValidationCreationData: Object

Type declaration

Name Type
file CustomFileData | CustomFile

Defined in

Types/Validations/MultipleValidation.ts:64

MultipleValidationCreationDataUpdated

Ƭ MultipleValidationCreationDataUpdated: Object

Type declaration

Name Type
multipleValidationFile CustomFileData | CustomFile

Defined in

Types/Validations/MultipleValidation.ts:67

MultipleValidationJobData

Ƭ MultipleValidationJobData: Object

Type declaration

Name Type
created_at number
download_url? { csv: string ; json: string }
download_url.csv string
download_url.json string
id string
quantity number
records_processed number | null
status string
summary? { result: { catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number } ; risk: { high: number ; low: number ; medium: number ; unknown: number } }
summary.result { catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number }
summary.result.catch_all number
summary.result.deliverable number
summary.result.do_not_send number
summary.result.undeliverable number
summary.result.unknown number
summary.risk { high: number ; low: number ; medium: number ; unknown: number }
summary.risk.high number
summary.risk.low number
summary.risk.medium number
summary.risk.unknown number

Defined in

Types/Validations/MultipleValidation.ts:5

MultipleValidationJobResult

Ƭ MultipleValidationJobResult: Object

Type declaration

Name Type
createdAt Date
downloadUrl? { csv: string ; json: string }
downloadUrl.csv string
downloadUrl.json string
id string
quantity number
recordsProcessed number | null
responseStatusCode number
status string
summary? { result: { catchAll: number ; deliverable: number ; doNotSend: number ; undeliverable: number ; unknown: number } ; risk: { high: number ; low: number ; medium: number ; unknown: number } }
summary.result { catchAll: number ; deliverable: number ; doNotSend: number ; undeliverable: number ; unknown: number }
summary.result.catchAll number
summary.result.deliverable number
summary.result.doNotSend number
summary.result.undeliverable number
summary.result.unknown number
summary.risk { high: number ; low: number ; medium: number ; unknown: number }
summary.risk.high number
summary.risk.low number
summary.risk.medium number
summary.risk.unknown number

Defined in

Types/Validations/MultipleValidation.ts:32

MultipleValidationJobsListQuery

Ƭ MultipleValidationJobsListQuery: Object

Type declaration

Name Type
limit number
page? string

Defined in

Types/Validations/MultipleValidation.ts:78

MultipleValidationJobsListResponse

Ƭ MultipleValidationJobsListResponse: Object

Type declaration

Name Type
body { jobs: MultipleValidationJobData[] ; paging: PagesList ; total: number }
body.jobs MultipleValidationJobData[]
body.paging PagesList
body.total number
status number

Defined in

Types/Validations/MultipleValidation.ts:83

MultipleValidationJobsListResult

Ƭ MultipleValidationJobsListResult: Object

Type declaration

Name Type
jobs MultipleValidationJobResult[]
pages ParsedPagesList
status number
total number

Defined in

Types/Validations/MultipleValidation.ts:71

MutateDomainTemplateVersionAPIResponse

Ƭ MutateDomainTemplateVersionAPIResponse: Object

Type declaration

Name Type
body { message: string ; template: { name: string ; version: { tag: string } } }
body.message string
body.template { name: string ; version: { tag: string } }
body.template.name string
body.template.version { tag: string }
body.template.version.tag string
status number

Defined in

Types/Domains/DomainTemplates.ts:136

MutateDomainTemplateVersionResult

Ƭ MutateDomainTemplateVersionResult: Object

Type declaration

Name Type
message string
status number
templateName string
templateVersion { tag: string }
templateVersion.tag string

Defined in

Types/Domains/DomainTemplates.ts:149

NewMultipleMembersResponse

Ƭ NewMultipleMembersResponse: Object

Type declaration

Name Type
list MailingList
message string
task-id string

Defined in

Types/MailingLists/MailingListMembers.ts:52

NotificationAPIResponse

Ƭ NotificationAPIResponse: Object

Type declaration

Name Type
body { message: string }
body.message string
status number

Defined in

Types/Domains/DomainTemplates.ts:110

NotificationResult

Ƭ NotificationResult: Object

Type declaration

Name Type
message string
status number

Defined in

Types/Domains/DomainTemplates.ts:117

OnCallEmptyHeaders

Ƭ OnCallEmptyHeaders: Object

Index signature

▪ [key: string]: undefined

Defined in

Types/Common/RequestOptions.ts:4

OnCallRequestOptions

Ƭ OnCallRequestOptions: Object

Index signature

▪ [key: string]: unknown | undefined

Type declaration

Name Type
headers? AxiosRequestHeaders | RawAxiosRequestHeaders
query? any
timeout? number

Defined in

Types/Common/RequestOptions.ts:12

OpenTrackingInfo

Ƭ OpenTrackingInfo: Object

Type declaration

Name Type
active "yes" | "no" | "true" | "false"

Defined in

Types/Domains/DomainTracking.ts:36

PagesList

Ƭ PagesList: Object

Type declaration

Name Type
first string
last string
next string
previous string

Defined in

Types/Common/NavigationThruPages.ts:1

PagesListAccumulator

Ƭ PagesListAccumulator: Object

Index signature

▪ [index: string]: ParsedPage

Defined in

Types/Common/NavigationThruPages.ts:22

ParsedPage

Ƭ ParsedPage: Object

Type declaration

Name Type
id string
iteratorPosition string | undefined
page string
url string

Defined in

Types/Common/NavigationThruPages.ts:8

ParsedPagesList

Ƭ ParsedPagesList: Object

Type declaration

Name Type
first ParsedPage
last ParsedPage
next ParsedPage
previous ParsedPage

Defined in

Types/Common/NavigationThruPages.ts:15

QueryWithPage

Ƭ QueryWithPage: Object

Type declaration

Name Type
page? string

Defined in

Types/Common/NavigationThruPages.ts:32

ReplacementForPool

Ƭ ReplacementForPool: Object

Type declaration

Name Type
ip? string
pool_id? string

Defined in

Types/Domains/Domains.ts:156

RequestOptions

Ƭ RequestOptions: MailgunClientOptions & { headers: AxiosRequestHeaders | RawAxiosRequestHeaders ; timeout: number }

Defined in

Types/Common/RequestOptions.ts:7

ResponseWithPaging

Ƭ ResponseWithPaging: Object

Type declaration

Name Type
body { paging: PagesList }
body.paging PagesList

Defined in

Types/Common/NavigationThruPages.ts:26

Route

Ƭ Route: Object

Type declaration

Name Type
actions string[]
created_at string
description string
expression string
id string
priority number

Defined in

Types/Routes/Routes.ts:2

RoutesListQuery

Ƭ RoutesListQuery: Object

Type declaration

Name Type
limit? number
skip? number

Defined in

Types/Routes/Routes.ts:27

ShortTemplateVersion

Ƭ ShortTemplateVersion: Object

Type declaration

Name Type
active boolean
comment string
createdAt string | Date
engine string
id string
mjml string
tag string

Defined in

Types/Domains/DomainTemplates.ts:46

StartValidationResult

Ƭ StartValidationResult: Object

Type declaration

Name Type
id string
message string
status number

Defined in

Types/MailingLists/MailingLists.ts:23

Stat

Ƭ Stat: Object

Type declaration

Name Type
delivered { http: number ; smtp: number ; total: number }
delivered.http number
delivered.smtp number
delivered.total number
time string | Date

Defined in

Types/Stats/Stats.ts:1

StatsEvent

Ƭ StatsEvent: "accepted" | "delivered" | "opened" | "clicked" | "unsubscribed" | "stored" | "complained" | "failed"

Defined in

Types/Stats/Stats.ts:17

StatsOptions

Ƭ StatsOptions: Object

Type declaration

Name Type
end string | Date
resolution string
start string | Date
stats Stat[]

Defined in

Types/Stats/Stats.ts:10

StatsQuery

Ƭ StatsQuery: Object

Type declaration

Name Type
duration? string
end? string | Date
event StatsEvent | StatsEvent[]
resolution? "hour" | "day" | "month"
start? string | Date

Defined in

Types/Stats/Stats.ts:19

SubaccountListItem

Ƭ SubaccountListItem: Object

Type declaration

Name Type
id string
name string
status string

Defined in

Types/Subaccounts/Subaccounts.ts:8

SubaccountListResponseData

Ƭ SubaccountListResponseData: Object

Type declaration

Name Type
subaccounts SubaccountListItem[]
total number

Defined in

Types/Subaccounts/Subaccounts.ts:14

SubaccountResponseData

Ƭ SubaccountResponseData: Object

Type declaration

Name Type
subaccount SubaccountListItem

Defined in

Types/Subaccounts/Subaccounts.ts:19

SubaccountsQuery

Ƭ SubaccountsQuery: Object

Type declaration

Name Type
enabled? boolean
limit? number
skip? number
sort? "asc" | "desc"

Defined in

Types/Subaccounts/Subaccounts.ts:1

SuppressionCreationData

Ƭ SuppressionCreationData: Object

Type declaration

Name Type
address string
code? number
created_at? string
domain? string
error? string
tag? string
tags? string[]

Defined in

Types/Suppressions/Suppressions.ts:57

SuppressionCreationResponse

Ƭ SuppressionCreationResponse: Object

Type declaration

Name Type
body { message: string ; type?: string ; value?: string }
body.message string
body.type? string
body.value? string
status number

Defined in

Types/Suppressions/Suppressions.ts:67

SuppressionCreationResult

Ƭ SuppressionCreationResult: Object

Type declaration

Name Type
message string
status number
type string
value string

Defined in

Types/Suppressions/Suppressions.ts:76

SuppressionDataType

Ƭ SuppressionDataType: BounceData | ComplaintData | UnsubscribeData | WhiteListData

Defined in

Types/Suppressions/Suppressions.ts:26

SuppressionDestroyResponse

Ƭ SuppressionDestroyResponse: Object

Type declaration

Name Type
body { address?: string ; message: string ; value?: string }
body.address? string
body.message string
body.value? string
status number

Defined in

Types/Suppressions/Suppressions.ts:41

SuppressionDestroyResult

Ƭ SuppressionDestroyResult: Object

Type declaration

Name Type
address string
message string
status number
value string

Defined in

Types/Suppressions/Suppressions.ts:50

SuppressionList

Ƭ SuppressionList: Object

Type declaration

Name Type
items (IBounce | IComplaint | IUnsubscribe | IWhiteList)[]
pages ParsedPagesList
status number

Defined in

Types/Suppressions/Suppressions.ts:15

SuppressionListQuery

Ƭ SuppressionListQuery: Object

Type declaration

Name Type
limit? number
page? string

Defined in

Types/Suppressions/Suppressions.ts:21

SuppressionListResponse

Ƭ SuppressionListResponse: Object

Type declaration

Name Type
body { items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[] ; paging: PagesList }
body.items BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[]
body.paging PagesList
status number

Defined in

Types/Suppressions/Suppressions.ts:28

SuppressionResponse

Ƭ SuppressionResponse: Object

Type declaration

Name Type
body SuppressionDataType
status number

Defined in

Types/Suppressions/Suppressions.ts:36

TDomain

Ƭ TDomain: Object

Type declaration

Name Type
created_at string
id? string
is_disabled? boolean
name string
receiving_dns_records DNSRecord[] | null
require_tls boolean
sending_dns_records DNSRecord[] | null
skip_verification boolean
smtp_login string
smtp_password string
spam_action string
state string
type string
web_prefix? string
web_scheme? string
wildcard boolean

Defined in

Types/Domains/Domains.ts:161

TemplateQuery

Ƭ TemplateQuery: Object

Type declaration

Name Type
active YesNo

Defined in

Types/Domains/DomainTemplates.ts:42

TemplateVersion

Ƭ TemplateVersion: ShortTemplateVersion & { template: string }

Defined in

Types/Domains/DomainTemplates.ts:56

UnsubscribeData

Ƭ UnsubscribeData: Object

Type declaration

Name Type
address string
created_at string | Date
tags any

Defined in

Types/Suppressions/Unsubscribe.ts:2

UnsubscribeTrackingInfo

Ƭ UnsubscribeTrackingInfo: Object

Type declaration

Name Type
active "yes" | "no" | "true" | "false"
html_footer string
text_footer string

Defined in

Types/Domains/DomainTracking.ts:43

UpdateDomainCredentialsData

Ƭ UpdateDomainCredentialsData: Object

Type declaration

Name Type
password string

Defined in

Types/Domains/DomainCredentials.ts:51

UpdateDomainTrackingResponse

Ƭ UpdateDomainTrackingResponse: Object

Type declaration

Name Type
body UpdatedOpenTracking
status number

Defined in

Types/Domains/DomainTracking.ts:31

UpdateOrDeleteDomainTemplateAPIResponse

Ƭ UpdateOrDeleteDomainTemplateAPIResponse: Object

Type declaration

Name Type
body { message: string ; template: { name: string } }
body.message string
body.template { name: string }
body.template.name string
status number

Defined in

Types/Domains/DomainTemplates.ts:94

UpdateOrDeleteDomainTemplateResult

Ƭ UpdateOrDeleteDomainTemplateResult: Object

Type declaration

Name Type
message string
status number
templateName? string

Defined in

Types/Domains/DomainTemplates.ts:104

UpdateRouteResponse

Ƭ UpdateRouteResponse: Route & { message: string }

Defined in

Types/Routes/Routes.ts:11

UpdatedConnectionSettings

Ƭ UpdatedConnectionSettings: Object

Type declaration

Name Type
message string
require_tls boolean
skip_verification boolean

Defined in

Types/Domains/Domains.ts:109

UpdatedConnectionSettingsRes

Ƭ UpdatedConnectionSettingsRes: Object

Type declaration

Name Type
body UpdatedConnectionSettings
status number

Defined in

Types/Domains/Domains.ts:115

UpdatedDKIMAuthority

Ƭ UpdatedDKIMAuthority: Object

Type declaration

Name Type
changed boolean
message string
sending_dns_records DNSRecord[]

Defined in

Types/Domains/Domains.ts:124

UpdatedDKIMAuthorityResponse

Ƭ UpdatedDKIMAuthorityResponse: Object

Type declaration

Name Type
body UpdatedDKIMAuthority
status 200

Defined in

Types/Domains/Domains.ts:130

UpdatedDKIMSelectorResponse

Ƭ UpdatedDKIMSelectorResponse: Object

Type declaration

Name Type
body MessageResponse
status number

Defined in

Types/Domains/Domains.ts:139

UpdatedOpenTracking

Ƭ UpdatedOpenTracking: Object

Type declaration

Name Type
click? { active: boolean | "htmlonly" }
click.active boolean | "htmlonly"
message string
open? { active: boolean }
open.active boolean
unsubscribe? { active: boolean ; html_footer: string ; text_footer: string }
unsubscribe.active boolean
unsubscribe.html_footer string
unsubscribe.text_footer string

Defined in

Types/Domains/DomainTracking.ts:20

UpdatedUrlAndQuery

Ƭ UpdatedUrlAndQuery: Object

Type declaration

Name Type
updatedQuery Record<string, unknown>
url string

Defined in

Types/Common/NavigationThruPages.ts:36

UpdatedWebPrefix

Ƭ UpdatedWebPrefix: Object

Type declaration

Name Type
message string

Defined in

Types/Domains/Domains.ts:148

UpdatedWebPrefixResponse

Ƭ UpdatedWebPrefixResponse: Object

Type declaration

Name Type
body MessageResponse
status number

Defined in

Types/Domains/Domains.ts:151

ValidationQuery

Ƭ ValidationQuery: Object

Type declaration

Name Type
address string

Defined in

Types/Validations/Validation.ts:3

ValidationResponse

Ƭ ValidationResponse: Object

Type declaration

Name Type
body ValidationResult
status number

Defined in

Types/Validations/Validation.ts:15

ValidationResult

Ƭ ValidationResult: Object

Type declaration

Name Type
address string
is_disposable_address boolean
is_role_address boolean
reason string[]
result string
risk string

Defined in

Types/Validations/Validation.ts:6

WebPrefixInfo

Ƭ WebPrefixInfo: Object

Type declaration

Name Type
webPrefix string

Defined in

Types/Domains/Domains.ts:144

WebhookList

Ƭ WebhookList: Object

Index signature

▪ [id: string]: { urls: string[] }

Defined in

Types/Webhooks/Webhooks.ts:16

WebhookResponse

Ƭ WebhookResponse: Object

Type declaration

Name Type
body WebhookResponseBody
status number

Defined in

Types/Webhooks/Webhooks.ts:11

WebhookResponseBody

Ƭ WebhookResponseBody: Object

Type declaration

Name Type
message string
webhook APIWebhook

Defined in

Types/Webhooks/Webhooks.ts:6

WebhookResult

Ƭ WebhookResult: Object

Type declaration

Name Type Description
id string -
url string | undefined Deprecated url property is deprecated. Use "urls" instead.
urls string[] -

Defined in

Types/Webhooks/Webhooks.ts:32

WebhookValidationResponse

Ƭ WebhookValidationResponse: Object

Type declaration

Name Type
code number
message string

Defined in

Types/Webhooks/Webhooks.ts:27

WebhooksQuery

Ƭ WebhooksQuery: Object

Type declaration

Name Type
limit? number
skip? number

Defined in

Types/Webhooks/Webhooks.ts:22

WhiteListData

Ƭ WhiteListData: Object

Type declaration

Name Type
createdAt string | Date
reason string
type string
value string

Defined in

Types/Suppressions/WhiteList.ts:1