mailgun.js 4.1.5 → 4.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/README.md +128 -27
- package/dist/lib/domains.d.ts +4 -1
- package/dist/lib/domainsTags.d.ts +34 -0
- package/dist/lib/interfaces/DomainTags.d.ts +228 -0
- package/dist/mailgun.node.js +2 -2
- package/dist/mailgun.node.js.LICENSE.txt +1 -1
- package/dist/mailgun.web.js +2 -2
- package/dist/mailgun.web.js.LICENSE.txt +1 -1
- package/docs/.nojekyll +1 -0
- package/docs/assets/highlight.css +127 -0
- package/docs/assets/icons.css +1043 -0
- package/docs/assets/{images/icons.png → icons.png} +0 -0
- package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
- package/docs/assets/main.js +52 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1413 -0
- package/docs/assets/{images/widgets.png → widgets.png} +0 -0
- package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
- package/docs/classes/client.default.html +1 -0
- package/docs/classes/domains.Domain.html +1 -0
- package/docs/classes/domains.default.html +1 -0
- package/docs/classes/domainsCredentials.default.html +1 -0
- package/docs/classes/domainsTemplates.DomainTemplateItem.html +1 -0
- package/docs/classes/domainsTemplates.default.html +1 -0
- package/docs/classes/error.default.html +6 -0
- package/docs/classes/events.default.html +1 -0
- package/docs/classes/ip_pools.default.html +1 -0
- package/docs/classes/ips.default.html +1 -0
- package/docs/classes/lists.default.html +1 -0
- package/docs/classes/mailListMembers.default.html +1 -0
- package/docs/classes/messages.default.html +1 -0
- package/docs/classes/multipleValidation.default.html +1 -0
- package/docs/classes/request.default.html +1 -0
- package/docs/classes/routes.default.html +1 -0
- package/docs/classes/stats.default.html +1 -0
- package/docs/classes/suppressions.default.html +1 -0
- package/docs/classes/validate.default.html +1 -0
- package/docs/classes/webhooks.default.html +1 -0
- package/docs/enums/interfaces_DomainTemplates.Pages.html +1 -0
- package/docs/enums/interfaces_DomainTemplates.YesNo.html +1 -0
- package/docs/index.html +1140 -1308
- package/docs/interfaces/interfaces_APIErrorOptions.default.html +1 -0
- package/docs/interfaces/interfaces_ApiResponse.default.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.CreatedUpdatedDomainCredentialsResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DeletedDomainCredentialsResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DomainCredentials.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsItem.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsList.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsQuery.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsResponseData.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsResult.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.IDomainCredentials.html +1 -0
- package/docs/interfaces/interfaces_DomainCredentials.UpdateDomainCredentialsData.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.CreateDomainTemplateAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.CreateDomainTemplateVersionAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.CreateDomainTemplateVersionResult.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.DomainTemplate.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateData.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateUpdateData.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateUpdateVersionData.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateVersionData.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.DomainTemplatesQuery.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.GetDomainTemplateAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.IDomainTemplatesClient.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplateVersionsAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplateVersionsResult.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplatesAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplatesResult.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.MutateDomainTemplateVersionAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.MutateDomainTemplateVersionResult.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.NotificationAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.NotificationResult.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.ShortTemplateVersion.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.TemplateQuery.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.TemplateVersion.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.UpdateOrDeleteDomainTemplateAPIResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTemplates.UpdateOrDeleteDomainTemplateResult.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.ClickTrackingInfo.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.DomainTrackingData.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.DomainTrackingResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.OpenTrackingInfo.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.UnsubscribeTrackingInfo.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.UpdateDomainTrackingResponse.html +1 -0
- package/docs/interfaces/interfaces_DomainTracking.UpdatedOpenTracking.html +1 -0
- package/docs/interfaces/interfaces_Domains.ConnectionSettings.html +1 -0
- package/docs/interfaces/interfaces_Domains.ConnectionSettingsResponse.html +1 -0
- package/docs/interfaces/interfaces_Domains.DKIMAuthorityInfo.html +1 -0
- package/docs/interfaces/interfaces_Domains.DKIMSelectorInfo.html +1 -0
- package/docs/interfaces/interfaces_Domains.DNSRecord.html +1 -0
- package/docs/interfaces/interfaces_Domains.DestroyedDomainResponse.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainData.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainInfo.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainListResponseData.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainResponseData.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainShortData.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainsListItem.html +1 -0
- package/docs/interfaces/interfaces_Domains.DomainsQuery.html +1 -0
- package/docs/interfaces/interfaces_Domains.MessageResponse.html +1 -0
- package/docs/interfaces/interfaces_Domains.ReplacementForPool.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedConnectionSettings.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedConnectionSettingsRes.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedDKIMAuthority.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedDKIMAuthorityResponse.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedDKIMSelectorResponse.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedWebPrefix.html +1 -0
- package/docs/interfaces/interfaces_Domains.UpdatedWebPrefixResponse.html +1 -0
- package/docs/interfaces/interfaces_Domains.WebPrefixInfo.html +1 -0
- package/docs/interfaces/interfaces_Events.DomainEvent.html +1 -0
- package/docs/interfaces/interfaces_Events.EventsList.html +1 -0
- package/docs/interfaces/interfaces_Events.EventsPage.html +1 -0
- package/docs/interfaces/interfaces_Events.EventsResponse.html +1 -0
- package/docs/interfaces/interfaces_Events.PagesList.html +1 -0
- package/docs/interfaces/interfaces_Events.PagesListAccumulator.html +1 -0
- package/docs/interfaces/interfaces_Events.ParsedPage.html +1 -0
- package/docs/interfaces/interfaces_Events.ParsedPagesList.html +1 -0
- package/docs/interfaces/interfaces_IFormData.IFormDataOptions.html +1 -0
- package/docs/interfaces/interfaces_IFormData.InputFormData.html +1 -0
- package/docs/interfaces/interfaces_IpPools.IpPool.html +1 -0
- package/docs/interfaces/interfaces_IpPools.IpPoolListResponse.html +1 -0
- package/docs/interfaces/interfaces_IpPools.IpPoolUpdateData.html +1 -0
- package/docs/interfaces/interfaces_Ips.IpData.html +1 -0
- package/docs/interfaces/interfaces_Ips.IpsListResponseBody.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.CanceledMultipleValidationJob.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.CreatedMultipleValidationJob.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.IMultipleValidationClient.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.MultipleValidationJob.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.MultipleValidationJobsListResponse.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.MultipleValidationJobsListResult.html +1 -0
- package/docs/interfaces/interfaces_MultipleValidation.PagesList.html +1 -0
- package/docs/interfaces/interfaces_Options.default.html +1 -0
- package/docs/interfaces/interfaces_RequestOptions.default.html +1 -0
- package/docs/interfaces/interfaces_StatsOptions.Stat.html +1 -0
- package/docs/interfaces/interfaces_StatsOptions.StatsOptions.html +1 -0
- package/docs/interfaces/interfaces_StatsOptions.StatsQuery.html +1 -0
- package/docs/interfaces/interfaces_Supressions.BounceData.html +1 -0
- package/docs/interfaces/interfaces_Supressions.ComplaintData.html +1 -0
- package/docs/interfaces/interfaces_Supressions.UnsubscribeData.html +1 -0
- package/docs/interfaces/interfaces_Supressions.WhiteListData.html +1 -0
- package/docs/interfaces/interfaces_Validate.ValidationResponse.html +1 -0
- package/docs/interfaces/interfaces_Validate.ValidationResult.html +1 -0
- package/docs/interfaces/interfaces_Webhooks.APIWebhook.html +1 -0
- package/docs/interfaces/interfaces_Webhooks.ValidationResponse.html +1 -0
- package/docs/interfaces/interfaces_Webhooks.WebhookList.html +1 -0
- package/docs/interfaces/interfaces_Webhooks.WebhookResponse.html +1 -0
- package/docs/interfaces/interfaces_Webhooks.WebhookResponseBody.html +1 -0
- package/docs/interfaces/interfaces_Webhooks.WebhooksQuery.html +1 -0
- package/docs/interfaces/interfaces_lists.CreateUpdateList.html +1 -0
- package/docs/interfaces/interfaces_lists.DestroyedList.html +1 -0
- package/docs/interfaces/interfaces_lists.ListsQuery.html +1 -0
- package/docs/interfaces/interfaces_lists.MailingList.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.CreateUpdateMailListMembers.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.CreateUpdateMailListMembersReq.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.DeletedMember.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.IMailListsMembers.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.MailListMember.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.MailListMembersQuery.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.MultipleMembersData.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.MultipleMembersReqData.html +1 -0
- package/docs/interfaces/interfaces_mailListMembers.NewMultipleMembersResponse.html +1 -0
- package/docs/interfaces/interfaces_routes.CreateUpdateRouteData.html +1 -0
- package/docs/interfaces/interfaces_routes.DestroyRouteResponse.html +1 -0
- package/docs/interfaces/interfaces_routes.Route.html +1 -0
- package/docs/interfaces/interfaces_routes.RoutesListQuery.html +1 -0
- package/docs/interfaces/interfaces_routes.UpdateRouteResponse.html +1 -0
- package/docs/modules/client.html +1 -0
- package/docs/modules/domains.html +1 -0
- package/docs/modules/domainsCredentials.html +1 -0
- package/docs/modules/domainsTemplates.html +1 -0
- package/docs/modules/error.html +1 -0
- package/docs/modules/events.html +1 -0
- package/docs/modules/interfaces_APIErrorOptions.html +1 -0
- package/docs/modules/interfaces_ApiResponse.html +1 -0
- package/docs/modules/interfaces_DomainCredentials.html +1 -0
- package/docs/modules/interfaces_DomainTemplates.html +1 -0
- package/docs/modules/interfaces_DomainTracking.html +1 -0
- package/docs/modules/interfaces_Domains.html +1 -0
- package/docs/modules/interfaces_Events.html +1 -0
- package/docs/modules/interfaces_IFormData.html +1 -0
- package/docs/modules/interfaces_IpPools.html +1 -0
- package/docs/modules/interfaces_Ips.html +1 -0
- package/docs/modules/interfaces_MultipleValidation.html +1 -0
- package/docs/modules/interfaces_Options.html +1 -0
- package/docs/modules/interfaces_RequestOptions.html +1 -0
- package/docs/modules/interfaces_StatsOptions.html +1 -0
- package/docs/modules/interfaces_Supressions.html +1 -0
- package/docs/modules/interfaces_Validate.html +1 -0
- package/docs/modules/interfaces_Webhooks.html +1 -0
- package/docs/modules/interfaces_lists.html +1 -0
- package/docs/modules/interfaces_mailListMembers.html +1 -0
- package/docs/modules/interfaces_routes.html +1 -0
- package/docs/modules/ip_pools.html +1 -0
- package/docs/modules/ips.html +1 -0
- package/docs/modules/lists.html +1 -0
- package/docs/modules/mailListMembers.html +1 -0
- package/docs/modules/messages.html +1 -0
- package/docs/modules/multipleValidation.html +1 -0
- package/docs/modules/request.html +1 -0
- package/docs/modules/routes.html +1 -0
- package/docs/modules/stats.html +1 -0
- package/docs/modules/suppressions.html +1 -0
- package/docs/modules/validate.html +1 -0
- package/docs/modules/webhooks.html +1 -0
- package/docs/modules.html +1 -0
- package/lib/client.ts +8 -1
- package/lib/domains.ts +7 -2
- package/lib/domainsTags.ts +165 -0
- package/lib/interfaces/DomainTags.ts +262 -0
- package/package.json +3 -3
- package/test/domains.test.ts +8 -1
- package/test/domainsTags.test.ts +345 -0
- package/tsconfig.json +2 -2
- package/docs/assets/css/main.css +0 -1
- package/docs/assets/js/main.js +0 -51
- package/docs/assets/js/search.json +0 -1
- package/docs/classes/_index_.mailgun.html +0 -294
- package/docs/classes/_lib_client_.client.html +0 -405
- package/docs/classes/_lib_domains_.domain.html +0 -422
- package/docs/classes/_lib_domains_.domainclient.html +0 -620
- package/docs/classes/_lib_error_.apierror.html +0 -362
- package/docs/classes/_lib_events_.eventclient.html +0 -465
- package/docs/classes/_lib_messages_.messagesclient.html +0 -327
- package/docs/classes/_lib_parse_.parseclient.html +0 -295
- package/docs/classes/_lib_request_.request.html +0 -698
- package/docs/classes/_lib_routes_.routesclient.html +0 -403
- package/docs/classes/_lib_stats_.stats.html +0 -301
- package/docs/classes/_lib_stats_.statsclient.html +0 -357
- package/docs/classes/_lib_suppressions_.bounce.html +0 -327
- package/docs/classes/_lib_suppressions_.complaint.html +0 -299
- package/docs/classes/_lib_suppressions_.suppressionclient.html +0 -599
- package/docs/classes/_lib_suppressions_.unsubscribe.html +0 -313
- package/docs/classes/_lib_validate_.validateclient.html +0 -292
- package/docs/classes/_lib_webhooks_.webhook.html +0 -281
- package/docs/classes/_lib_webhooks_.webhookclient.html +0 -539
- package/docs/globals.html +0 -199
- package/docs/interfaces/_lib_domains_.domaindata.html +0 -352
- package/docs/interfaces/_lib_interfaces_apierroroptions_.apierroroptions.html +0 -284
- package/docs/interfaces/_lib_interfaces_options_.options.html +0 -267
- package/docs/interfaces/_lib_interfaces_requestoptions_.requestoptions.html +0 -285
- package/docs/interfaces/_lib_interfaces_statsoptions_.statsoptions.html +0 -262
- package/docs/interfaces/_lib_interfaces_supressions_.bouncedata.html +0 -268
- package/docs/interfaces/_lib_interfaces_supressions_.complaintdata.html +0 -240
- package/docs/interfaces/_lib_interfaces_supressions_.unsubscribedata.html +0 -254
- package/docs/modules/_index_.html +0 -186
- package/docs/modules/_lib_client_.html +0 -208
- package/docs/modules/_lib_domains_.html +0 -199
- package/docs/modules/_lib_error_.html +0 -186
- package/docs/modules/_lib_events_.html +0 -250
- package/docs/modules/_lib_interfaces_apierroroptions_.html +0 -186
- package/docs/modules/_lib_interfaces_options_.html +0 -186
- package/docs/modules/_lib_interfaces_requestoptions_.html +0 -186
- package/docs/modules/_lib_interfaces_statsoptions_.html +0 -186
- package/docs/modules/_lib_interfaces_supressions_.html +0 -194
- package/docs/modules/_lib_messages_.html +0 -186
- package/docs/modules/_lib_parse_.html +0 -186
- package/docs/modules/_lib_request_.html +0 -259
- package/docs/modules/_lib_routes_.html +0 -186
- package/docs/modules/_lib_stats_.html +0 -190
- package/docs/modules/_lib_suppressions_.html +0 -262
- package/docs/modules/_lib_validate_.html +0 -186
- package/docs/modules/_lib_webhooks_.html +0 -190
- package/docs/modules/_webpack_config_.html +0 -227
- package/docs/modules/_webpack_release_config_.html +0 -227
|
@@ -1,620 +0,0 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<html class="default no-js">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>DomainClient | mailgun.js</title>
|
|
7
|
-
<meta name="description" content="Documentation for mailgun.js">
|
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
-
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
-
</head>
|
|
11
|
-
<body>
|
|
12
|
-
<header>
|
|
13
|
-
<div class="tsd-page-toolbar">
|
|
14
|
-
<div class="container">
|
|
15
|
-
<div class="table-wrap">
|
|
16
|
-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
17
|
-
<div class="field">
|
|
18
|
-
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
-
<input id="tsd-search-field" type="text" />
|
|
20
|
-
</div>
|
|
21
|
-
<ul class="results">
|
|
22
|
-
<li class="state loading">Preparing search index...</li>
|
|
23
|
-
<li class="state failure">The search index is not available</li>
|
|
24
|
-
</ul>
|
|
25
|
-
<a href="../index.html" class="title">mailgun.js</a>
|
|
26
|
-
</div>
|
|
27
|
-
<div class="table-cell" id="tsd-widgets">
|
|
28
|
-
<div id="tsd-filter">
|
|
29
|
-
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
-
<div class="tsd-filter-group">
|
|
31
|
-
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
-
<span class="tsd-select-label">All</span>
|
|
33
|
-
<ul class="tsd-select-list">
|
|
34
|
-
<li data-value="public">Public</li>
|
|
35
|
-
<li data-value="protected">Public/Protected</li>
|
|
36
|
-
<li data-value="private" class="selected">All</li>
|
|
37
|
-
</ul>
|
|
38
|
-
</div>
|
|
39
|
-
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
-
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
-
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
-
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
-
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
44
|
-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
45
|
-
</div>
|
|
46
|
-
</div>
|
|
47
|
-
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
48
|
-
</div>
|
|
49
|
-
</div>
|
|
50
|
-
</div>
|
|
51
|
-
</div>
|
|
52
|
-
<div class="tsd-page-title">
|
|
53
|
-
<div class="container">
|
|
54
|
-
<ul class="tsd-breadcrumb">
|
|
55
|
-
<li>
|
|
56
|
-
<a href="../globals.html">Globals</a>
|
|
57
|
-
</li>
|
|
58
|
-
<li>
|
|
59
|
-
<a href="../modules/_lib_domains_.html">"lib/domains"</a>
|
|
60
|
-
</li>
|
|
61
|
-
<li>
|
|
62
|
-
<a href="_lib_domains_.domainclient.html">DomainClient</a>
|
|
63
|
-
</li>
|
|
64
|
-
</ul>
|
|
65
|
-
<h1>Class DomainClient</h1>
|
|
66
|
-
</div>
|
|
67
|
-
</div>
|
|
68
|
-
</header>
|
|
69
|
-
<div class="container container-main">
|
|
70
|
-
<div class="row">
|
|
71
|
-
<div class="col-8 col-content">
|
|
72
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
73
|
-
<h3>Hierarchy</h3>
|
|
74
|
-
<ul class="tsd-hierarchy">
|
|
75
|
-
<li>
|
|
76
|
-
<span class="target">DomainClient</span>
|
|
77
|
-
</li>
|
|
78
|
-
</ul>
|
|
79
|
-
</section>
|
|
80
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
81
|
-
<h2>Index</h2>
|
|
82
|
-
<section class="tsd-panel tsd-index-panel">
|
|
83
|
-
<div class="tsd-index-content">
|
|
84
|
-
<section class="tsd-index-section ">
|
|
85
|
-
<h3>Constructors</h3>
|
|
86
|
-
<ul class="tsd-index-list">
|
|
87
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
88
|
-
</ul>
|
|
89
|
-
</section>
|
|
90
|
-
<section class="tsd-index-section ">
|
|
91
|
-
<h3>Properties</h3>
|
|
92
|
-
<ul class="tsd-index-list">
|
|
93
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#request" class="tsd-kind-icon">request</a></li>
|
|
94
|
-
</ul>
|
|
95
|
-
</section>
|
|
96
|
-
<section class="tsd-index-section ">
|
|
97
|
-
<h3>Methods</h3>
|
|
98
|
-
<ul class="tsd-index-list">
|
|
99
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#_parsedomain" class="tsd-kind-icon">_parse<wbr>Domain</a></li>
|
|
100
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#_parsedomainlist" class="tsd-kind-icon">_parse<wbr>Domain<wbr>List</a></li>
|
|
101
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#_parsemessage" class="tsd-kind-icon">_parse<wbr>Message</a></li>
|
|
102
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#_parsetrackingsettings" class="tsd-kind-icon">_parse<wbr>Tracking<wbr>Settings</a></li>
|
|
103
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#_parsetrackingupdate" class="tsd-kind-icon">_parse<wbr>Tracking<wbr>Update</a></li>
|
|
104
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#create" class="tsd-kind-icon">create</a></li>
|
|
105
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#destroy" class="tsd-kind-icon">destroy</a></li>
|
|
106
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#get" class="tsd-kind-icon">get</a></li>
|
|
107
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#gettracking" class="tsd-kind-icon">get<wbr>Tracking</a></li>
|
|
108
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#list" class="tsd-kind-icon">list</a></li>
|
|
109
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_domains_.domainclient.html#updatetracking" class="tsd-kind-icon">update<wbr>Tracking</a></li>
|
|
110
|
-
</ul>
|
|
111
|
-
</section>
|
|
112
|
-
</div>
|
|
113
|
-
</section>
|
|
114
|
-
</section>
|
|
115
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
116
|
-
<h2>Constructors</h2>
|
|
117
|
-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
118
|
-
<a name="constructor" class="tsd-anchor"></a>
|
|
119
|
-
<h3>constructor</h3>
|
|
120
|
-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
121
|
-
<li class="tsd-signature tsd-kind-icon">new <wbr>Domain<wbr>Client<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="_lib_request_.request.html" class="tsd-signature-type">Request</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_domains_.domainclient.html" class="tsd-signature-type">DomainClient</a></li>
|
|
122
|
-
</ul>
|
|
123
|
-
<ul class="tsd-descriptions">
|
|
124
|
-
<li class="tsd-description">
|
|
125
|
-
<aside class="tsd-sources">
|
|
126
|
-
<ul>
|
|
127
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L50">lib/domains.ts:50</a></li>
|
|
128
|
-
</ul>
|
|
129
|
-
</aside>
|
|
130
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
131
|
-
<ul class="tsd-parameters">
|
|
132
|
-
<li>
|
|
133
|
-
<h5>request: <a href="_lib_request_.request.html" class="tsd-signature-type">Request</a></h5>
|
|
134
|
-
</li>
|
|
135
|
-
</ul>
|
|
136
|
-
<h4 class="tsd-returns-title">Returns <a href="_lib_domains_.domainclient.html" class="tsd-signature-type">DomainClient</a></h4>
|
|
137
|
-
</li>
|
|
138
|
-
</ul>
|
|
139
|
-
</section>
|
|
140
|
-
</section>
|
|
141
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
142
|
-
<h2>Properties</h2>
|
|
143
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
144
|
-
<a name="request" class="tsd-anchor"></a>
|
|
145
|
-
<h3>request</h3>
|
|
146
|
-
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="_lib_request_.request.html" class="tsd-signature-type">Request</a></div>
|
|
147
|
-
<aside class="tsd-sources">
|
|
148
|
-
<ul>
|
|
149
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L50">lib/domains.ts:50</a></li>
|
|
150
|
-
</ul>
|
|
151
|
-
</aside>
|
|
152
|
-
</section>
|
|
153
|
-
</section>
|
|
154
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
155
|
-
<h2>Methods</h2>
|
|
156
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
157
|
-
<a name="_parsedomain" class="tsd-anchor"></a>
|
|
158
|
-
<h3>_parse<wbr>Domain</h3>
|
|
159
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
160
|
-
<li class="tsd-signature tsd-kind-icon">_parse<wbr>Domain<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>receiving_dns_records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sending_dns_records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a></li>
|
|
161
|
-
</ul>
|
|
162
|
-
<ul class="tsd-descriptions">
|
|
163
|
-
<li class="tsd-description">
|
|
164
|
-
<aside class="tsd-sources">
|
|
165
|
-
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L66">lib/domains.ts:66</a></li>
|
|
167
|
-
</ul>
|
|
168
|
-
</aside>
|
|
169
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
170
|
-
<ul class="tsd-parameters">
|
|
171
|
-
<li>
|
|
172
|
-
<h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>receiving_dns_records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sending_dns_records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
173
|
-
<ul class="tsd-parameters">
|
|
174
|
-
<li class="tsd-parameter">
|
|
175
|
-
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>receiving_dns_records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sending_dns_records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
176
|
-
<ul class="tsd-parameters">
|
|
177
|
-
<li class="tsd-parameter">
|
|
178
|
-
<h5>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
179
|
-
</li>
|
|
180
|
-
<li class="tsd-parameter">
|
|
181
|
-
<h5>receiving_<wbr>dns_<wbr>records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
182
|
-
</li>
|
|
183
|
-
<li class="tsd-parameter">
|
|
184
|
-
<h5>sending_<wbr>dns_<wbr>records<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
185
|
-
</li>
|
|
186
|
-
</ul>
|
|
187
|
-
</li>
|
|
188
|
-
</ul>
|
|
189
|
-
</li>
|
|
190
|
-
</ul>
|
|
191
|
-
<h4 class="tsd-returns-title">Returns <a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a></h4>
|
|
192
|
-
</li>
|
|
193
|
-
</ul>
|
|
194
|
-
</section>
|
|
195
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
196
|
-
<a name="_parsedomainlist" class="tsd-anchor"></a>
|
|
197
|
-
<h3>_parse<wbr>Domain<wbr>List</h3>
|
|
198
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
199
|
-
<li class="tsd-signature tsd-kind-icon">_parse<wbr>Domain<wbr>List<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>items<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_domains_.domaindata.html" class="tsd-signature-type">DomainData</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">[]</span></li>
|
|
200
|
-
</ul>
|
|
201
|
-
<ul class="tsd-descriptions">
|
|
202
|
-
<li class="tsd-description">
|
|
203
|
-
<aside class="tsd-sources">
|
|
204
|
-
<ul>
|
|
205
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L60">lib/domains.ts:60</a></li>
|
|
206
|
-
</ul>
|
|
207
|
-
</aside>
|
|
208
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
209
|
-
<ul class="tsd-parameters">
|
|
210
|
-
<li>
|
|
211
|
-
<h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>items<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_domains_.domaindata.html" class="tsd-signature-type">DomainData</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
212
|
-
<ul class="tsd-parameters">
|
|
213
|
-
<li class="tsd-parameter">
|
|
214
|
-
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>items<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_domains_.domaindata.html" class="tsd-signature-type">DomainData</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
215
|
-
<ul class="tsd-parameters">
|
|
216
|
-
<li class="tsd-parameter">
|
|
217
|
-
<h5>items<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_domains_.domaindata.html" class="tsd-signature-type">DomainData</a></h5>
|
|
218
|
-
</li>
|
|
219
|
-
</ul>
|
|
220
|
-
</li>
|
|
221
|
-
</ul>
|
|
222
|
-
</li>
|
|
223
|
-
</ul>
|
|
224
|
-
<h4 class="tsd-returns-title">Returns <a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
225
|
-
</li>
|
|
226
|
-
</ul>
|
|
227
|
-
</section>
|
|
228
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
229
|
-
<a name="_parsemessage" class="tsd-anchor"></a>
|
|
230
|
-
<h3>_parse<wbr>Message</h3>
|
|
231
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
232
|
-
<li class="tsd-signature tsd-kind-icon">_parse<wbr>Message<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
233
|
-
</ul>
|
|
234
|
-
<ul class="tsd-descriptions">
|
|
235
|
-
<li class="tsd-description">
|
|
236
|
-
<aside class="tsd-sources">
|
|
237
|
-
<ul>
|
|
238
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L56">lib/domains.ts:56</a></li>
|
|
239
|
-
</ul>
|
|
240
|
-
</aside>
|
|
241
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
242
|
-
<ul class="tsd-parameters">
|
|
243
|
-
<li>
|
|
244
|
-
<h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
245
|
-
<ul class="tsd-parameters">
|
|
246
|
-
<li class="tsd-parameter">
|
|
247
|
-
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
248
|
-
</li>
|
|
249
|
-
</ul>
|
|
250
|
-
</li>
|
|
251
|
-
</ul>
|
|
252
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
253
|
-
</li>
|
|
254
|
-
</ul>
|
|
255
|
-
</section>
|
|
256
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
257
|
-
<a name="_parsetrackingsettings" class="tsd-anchor"></a>
|
|
258
|
-
<h3>_parse<wbr>Tracking<wbr>Settings</h3>
|
|
259
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
260
|
-
<li class="tsd-signature tsd-kind-icon">_parse<wbr>Tracking<wbr>Settings<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>tracking<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
261
|
-
</ul>
|
|
262
|
-
<ul class="tsd-descriptions">
|
|
263
|
-
<li class="tsd-description">
|
|
264
|
-
<aside class="tsd-sources">
|
|
265
|
-
<ul>
|
|
266
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L76">lib/domains.ts:76</a></li>
|
|
267
|
-
</ul>
|
|
268
|
-
</aside>
|
|
269
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
270
|
-
<ul class="tsd-parameters">
|
|
271
|
-
<li>
|
|
272
|
-
<h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>tracking<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
273
|
-
<ul class="tsd-parameters">
|
|
274
|
-
<li class="tsd-parameter">
|
|
275
|
-
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>tracking<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
276
|
-
<ul class="tsd-parameters">
|
|
277
|
-
<li class="tsd-parameter">
|
|
278
|
-
<h5>tracking<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
279
|
-
</li>
|
|
280
|
-
</ul>
|
|
281
|
-
</li>
|
|
282
|
-
</ul>
|
|
283
|
-
</li>
|
|
284
|
-
</ul>
|
|
285
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
286
|
-
</li>
|
|
287
|
-
</ul>
|
|
288
|
-
</section>
|
|
289
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
290
|
-
<a name="_parsetrackingupdate" class="tsd-anchor"></a>
|
|
291
|
-
<h3>_parse<wbr>Tracking<wbr>Update</h3>
|
|
292
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
293
|
-
<li class="tsd-signature tsd-kind-icon">_parse<wbr>Tracking<wbr>Update<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
294
|
-
</ul>
|
|
295
|
-
<ul class="tsd-descriptions">
|
|
296
|
-
<li class="tsd-description">
|
|
297
|
-
<aside class="tsd-sources">
|
|
298
|
-
<ul>
|
|
299
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L80">lib/domains.ts:80</a></li>
|
|
300
|
-
</ul>
|
|
301
|
-
</aside>
|
|
302
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
303
|
-
<ul class="tsd-parameters">
|
|
304
|
-
<li>
|
|
305
|
-
<h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
306
|
-
<ul class="tsd-parameters">
|
|
307
|
-
<li class="tsd-parameter">
|
|
308
|
-
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
309
|
-
</li>
|
|
310
|
-
</ul>
|
|
311
|
-
</li>
|
|
312
|
-
</ul>
|
|
313
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
314
|
-
</li>
|
|
315
|
-
</ul>
|
|
316
|
-
</section>
|
|
317
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
318
|
-
<a name="create" class="tsd-anchor"></a>
|
|
319
|
-
<h3>create</h3>
|
|
320
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
321
|
-
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">></span></li>
|
|
322
|
-
</ul>
|
|
323
|
-
<ul class="tsd-descriptions">
|
|
324
|
-
<li class="tsd-description">
|
|
325
|
-
<aside class="tsd-sources">
|
|
326
|
-
<ul>
|
|
327
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L94">lib/domains.ts:94</a></li>
|
|
328
|
-
</ul>
|
|
329
|
-
</aside>
|
|
330
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
331
|
-
<ul class="tsd-parameters">
|
|
332
|
-
<li>
|
|
333
|
-
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
|
334
|
-
</li>
|
|
335
|
-
</ul>
|
|
336
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">></span></h4>
|
|
337
|
-
</li>
|
|
338
|
-
</ul>
|
|
339
|
-
</section>
|
|
340
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
341
|
-
<a name="destroy" class="tsd-anchor"></a>
|
|
342
|
-
<h3>destroy</h3>
|
|
343
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
344
|
-
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
|
345
|
-
</ul>
|
|
346
|
-
<ul class="tsd-descriptions">
|
|
347
|
-
<li class="tsd-description">
|
|
348
|
-
<aside class="tsd-sources">
|
|
349
|
-
<ul>
|
|
350
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L99">lib/domains.ts:99</a></li>
|
|
351
|
-
</ul>
|
|
352
|
-
</aside>
|
|
353
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
354
|
-
<ul class="tsd-parameters">
|
|
355
|
-
<li>
|
|
356
|
-
<h5>domain: <span class="tsd-signature-type">string</span></h5>
|
|
357
|
-
</li>
|
|
358
|
-
</ul>
|
|
359
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
360
|
-
</li>
|
|
361
|
-
</ul>
|
|
362
|
-
</section>
|
|
363
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
364
|
-
<a name="get" class="tsd-anchor"></a>
|
|
365
|
-
<h3>get</h3>
|
|
366
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
367
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">></span></li>
|
|
368
|
-
</ul>
|
|
369
|
-
<ul class="tsd-descriptions">
|
|
370
|
-
<li class="tsd-description">
|
|
371
|
-
<aside class="tsd-sources">
|
|
372
|
-
<ul>
|
|
373
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L89">lib/domains.ts:89</a></li>
|
|
374
|
-
</ul>
|
|
375
|
-
</aside>
|
|
376
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
377
|
-
<ul class="tsd-parameters">
|
|
378
|
-
<li>
|
|
379
|
-
<h5>domain: <span class="tsd-signature-type">string</span></h5>
|
|
380
|
-
</li>
|
|
381
|
-
</ul>
|
|
382
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">></span></h4>
|
|
383
|
-
</li>
|
|
384
|
-
</ul>
|
|
385
|
-
</section>
|
|
386
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
387
|
-
<a name="gettracking" class="tsd-anchor"></a>
|
|
388
|
-
<h3>get<wbr>Tracking</h3>
|
|
389
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
390
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Tracking<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
|
391
|
-
</ul>
|
|
392
|
-
<ul class="tsd-descriptions">
|
|
393
|
-
<li class="tsd-description">
|
|
394
|
-
<aside class="tsd-sources">
|
|
395
|
-
<ul>
|
|
396
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L106">lib/domains.ts:106</a></li>
|
|
397
|
-
</ul>
|
|
398
|
-
</aside>
|
|
399
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
400
|
-
<ul class="tsd-parameters">
|
|
401
|
-
<li>
|
|
402
|
-
<h5>domain: <span class="tsd-signature-type">string</span></h5>
|
|
403
|
-
</li>
|
|
404
|
-
</ul>
|
|
405
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
406
|
-
</li>
|
|
407
|
-
</ul>
|
|
408
|
-
</section>
|
|
409
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
410
|
-
<a name="list" class="tsd-anchor"></a>
|
|
411
|
-
<h3>list</h3>
|
|
412
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
413
|
-
<li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
414
|
-
</ul>
|
|
415
|
-
<ul class="tsd-descriptions">
|
|
416
|
-
<li class="tsd-description">
|
|
417
|
-
<aside class="tsd-sources">
|
|
418
|
-
<ul>
|
|
419
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L84">lib/domains.ts:84</a></li>
|
|
420
|
-
</ul>
|
|
421
|
-
</aside>
|
|
422
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
423
|
-
<ul class="tsd-parameters">
|
|
424
|
-
<li>
|
|
425
|
-
<h5>query: <span class="tsd-signature-type">any</span></h5>
|
|
426
|
-
</li>
|
|
427
|
-
</ul>
|
|
428
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_domains_.domain.html" class="tsd-signature-type">Domain</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
429
|
-
</li>
|
|
430
|
-
</ul>
|
|
431
|
-
</section>
|
|
432
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
433
|
-
<a name="updatetracking" class="tsd-anchor"></a>
|
|
434
|
-
<h3>update<wbr>Tracking</h3>
|
|
435
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
436
|
-
<li class="tsd-signature tsd-kind-icon">update<wbr>Tracking<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
|
437
|
-
</ul>
|
|
438
|
-
<ul class="tsd-descriptions">
|
|
439
|
-
<li class="tsd-description">
|
|
440
|
-
<aside class="tsd-sources">
|
|
441
|
-
<ul>
|
|
442
|
-
<li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/domains.ts#L111">lib/domains.ts:111</a></li>
|
|
443
|
-
</ul>
|
|
444
|
-
</aside>
|
|
445
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
446
|
-
<ul class="tsd-parameters">
|
|
447
|
-
<li>
|
|
448
|
-
<h5>domain: <span class="tsd-signature-type">string</span></h5>
|
|
449
|
-
</li>
|
|
450
|
-
<li>
|
|
451
|
-
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
452
|
-
</li>
|
|
453
|
-
<li>
|
|
454
|
-
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
|
455
|
-
</li>
|
|
456
|
-
</ul>
|
|
457
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
458
|
-
</li>
|
|
459
|
-
</ul>
|
|
460
|
-
</section>
|
|
461
|
-
</section>
|
|
462
|
-
</div>
|
|
463
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
464
|
-
<nav class="tsd-navigation primary">
|
|
465
|
-
<ul>
|
|
466
|
-
<li class="globals ">
|
|
467
|
-
<a href="../globals.html"><em>Globals</em></a>
|
|
468
|
-
</li>
|
|
469
|
-
<li class=" tsd-kind-module">
|
|
470
|
-
<a href="../modules/_index_.html">"index"</a>
|
|
471
|
-
</li>
|
|
472
|
-
<li class=" tsd-kind-module">
|
|
473
|
-
<a href="../modules/_lib_client_.html">"lib/client"</a>
|
|
474
|
-
</li>
|
|
475
|
-
<li class="current tsd-kind-module">
|
|
476
|
-
<a href="../modules/_lib_domains_.html">"lib/domains"</a>
|
|
477
|
-
</li>
|
|
478
|
-
<li class=" tsd-kind-module">
|
|
479
|
-
<a href="../modules/_lib_error_.html">"lib/error"</a>
|
|
480
|
-
</li>
|
|
481
|
-
<li class=" tsd-kind-module">
|
|
482
|
-
<a href="../modules/_lib_events_.html">"lib/events"</a>
|
|
483
|
-
</li>
|
|
484
|
-
<li class=" tsd-kind-module">
|
|
485
|
-
<a href="../modules/_lib_interfaces_apierroroptions_.html">"lib/interfaces/APIError<wbr>Options"</a>
|
|
486
|
-
</li>
|
|
487
|
-
<li class=" tsd-kind-module">
|
|
488
|
-
<a href="../modules/_lib_interfaces_options_.html">"lib/interfaces/<wbr>Options"</a>
|
|
489
|
-
</li>
|
|
490
|
-
<li class=" tsd-kind-module">
|
|
491
|
-
<a href="../modules/_lib_interfaces_requestoptions_.html">"lib/interfaces/<wbr>Request<wbr>Options"</a>
|
|
492
|
-
</li>
|
|
493
|
-
<li class=" tsd-kind-module">
|
|
494
|
-
<a href="../modules/_lib_interfaces_statsoptions_.html">"lib/interfaces/<wbr>Stats<wbr>Options"</a>
|
|
495
|
-
</li>
|
|
496
|
-
<li class=" tsd-kind-module">
|
|
497
|
-
<a href="../modules/_lib_interfaces_supressions_.html">"lib/interfaces/<wbr>Supressions"</a>
|
|
498
|
-
</li>
|
|
499
|
-
<li class=" tsd-kind-module">
|
|
500
|
-
<a href="../modules/_lib_messages_.html">"lib/messages"</a>
|
|
501
|
-
</li>
|
|
502
|
-
<li class=" tsd-kind-module">
|
|
503
|
-
<a href="../modules/_lib_parse_.html">"lib/parse"</a>
|
|
504
|
-
</li>
|
|
505
|
-
<li class=" tsd-kind-module">
|
|
506
|
-
<a href="../modules/_lib_request_.html">"lib/request"</a>
|
|
507
|
-
</li>
|
|
508
|
-
<li class=" tsd-kind-module">
|
|
509
|
-
<a href="../modules/_lib_routes_.html">"lib/routes"</a>
|
|
510
|
-
</li>
|
|
511
|
-
<li class=" tsd-kind-module">
|
|
512
|
-
<a href="../modules/_lib_stats_.html">"lib/stats"</a>
|
|
513
|
-
</li>
|
|
514
|
-
<li class=" tsd-kind-module">
|
|
515
|
-
<a href="../modules/_lib_suppressions_.html">"lib/suppressions"</a>
|
|
516
|
-
</li>
|
|
517
|
-
<li class=" tsd-kind-module">
|
|
518
|
-
<a href="../modules/_lib_validate_.html">"lib/validate"</a>
|
|
519
|
-
</li>
|
|
520
|
-
<li class=" tsd-kind-module">
|
|
521
|
-
<a href="../modules/_lib_webhooks_.html">"lib/webhooks"</a>
|
|
522
|
-
</li>
|
|
523
|
-
<li class=" tsd-kind-module">
|
|
524
|
-
<a href="../modules/_webpack_config_.html">"webpack.config"</a>
|
|
525
|
-
</li>
|
|
526
|
-
<li class=" tsd-kind-module">
|
|
527
|
-
<a href="../modules/_webpack_release_config_.html">"webpack.release.config"</a>
|
|
528
|
-
</li>
|
|
529
|
-
</ul>
|
|
530
|
-
</nav>
|
|
531
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
532
|
-
<ul class="before-current">
|
|
533
|
-
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-not-exported">
|
|
534
|
-
<a href="_lib_domains_.domain.html" class="tsd-kind-icon">Domain</a>
|
|
535
|
-
</li>
|
|
536
|
-
</ul>
|
|
537
|
-
<ul class="current">
|
|
538
|
-
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
539
|
-
<a href="_lib_domains_.domainclient.html" class="tsd-kind-icon">Domain<wbr>Client</a>
|
|
540
|
-
<ul>
|
|
541
|
-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
542
|
-
<a href="_lib_domains_.domainclient.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
543
|
-
</li>
|
|
544
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
545
|
-
<a href="_lib_domains_.domainclient.html#request" class="tsd-kind-icon">request</a>
|
|
546
|
-
</li>
|
|
547
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
548
|
-
<a href="_lib_domains_.domainclient.html#_parsedomain" class="tsd-kind-icon">_parse<wbr>Domain</a>
|
|
549
|
-
</li>
|
|
550
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
551
|
-
<a href="_lib_domains_.domainclient.html#_parsedomainlist" class="tsd-kind-icon">_parse<wbr>Domain<wbr>List</a>
|
|
552
|
-
</li>
|
|
553
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
554
|
-
<a href="_lib_domains_.domainclient.html#_parsemessage" class="tsd-kind-icon">_parse<wbr>Message</a>
|
|
555
|
-
</li>
|
|
556
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
557
|
-
<a href="_lib_domains_.domainclient.html#_parsetrackingsettings" class="tsd-kind-icon">_parse<wbr>Tracking<wbr>Settings</a>
|
|
558
|
-
</li>
|
|
559
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
560
|
-
<a href="_lib_domains_.domainclient.html#_parsetrackingupdate" class="tsd-kind-icon">_parse<wbr>Tracking<wbr>Update</a>
|
|
561
|
-
</li>
|
|
562
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
563
|
-
<a href="_lib_domains_.domainclient.html#create" class="tsd-kind-icon">create</a>
|
|
564
|
-
</li>
|
|
565
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
566
|
-
<a href="_lib_domains_.domainclient.html#destroy" class="tsd-kind-icon">destroy</a>
|
|
567
|
-
</li>
|
|
568
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
569
|
-
<a href="_lib_domains_.domainclient.html#get" class="tsd-kind-icon">get</a>
|
|
570
|
-
</li>
|
|
571
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
572
|
-
<a href="_lib_domains_.domainclient.html#gettracking" class="tsd-kind-icon">get<wbr>Tracking</a>
|
|
573
|
-
</li>
|
|
574
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
575
|
-
<a href="_lib_domains_.domainclient.html#list" class="tsd-kind-icon">list</a>
|
|
576
|
-
</li>
|
|
577
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
578
|
-
<a href="_lib_domains_.domainclient.html#updatetracking" class="tsd-kind-icon">update<wbr>Tracking</a>
|
|
579
|
-
</li>
|
|
580
|
-
</ul>
|
|
581
|
-
</li>
|
|
582
|
-
</ul>
|
|
583
|
-
<ul class="after-current">
|
|
584
|
-
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported">
|
|
585
|
-
<a href="../interfaces/_lib_domains_.domaindata.html" class="tsd-kind-icon">Domain<wbr>Data</a>
|
|
586
|
-
</li>
|
|
587
|
-
</ul>
|
|
588
|
-
</nav>
|
|
589
|
-
</div>
|
|
590
|
-
</div>
|
|
591
|
-
</div>
|
|
592
|
-
<footer class="with-border-bottom">
|
|
593
|
-
<div class="container">
|
|
594
|
-
<h2>Legend</h2>
|
|
595
|
-
<div class="tsd-legend-group">
|
|
596
|
-
<ul class="tsd-legend">
|
|
597
|
-
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
598
|
-
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
599
|
-
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
600
|
-
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
601
|
-
</ul>
|
|
602
|
-
<ul class="tsd-legend">
|
|
603
|
-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
604
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
605
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
606
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
607
|
-
</ul>
|
|
608
|
-
<ul class="tsd-legend">
|
|
609
|
-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
610
|
-
</ul>
|
|
611
|
-
</div>
|
|
612
|
-
</div>
|
|
613
|
-
</footer>
|
|
614
|
-
<div class="container tsd-generator">
|
|
615
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
616
|
-
</div>
|
|
617
|
-
<div class="overlay"></div>
|
|
618
|
-
<script src="../assets/js/main.js"></script>
|
|
619
|
-
</body>
|
|
620
|
-
</html>
|