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.
Files changed (263) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/README.md +128 -27
  3. package/dist/lib/domains.d.ts +4 -1
  4. package/dist/lib/domainsTags.d.ts +34 -0
  5. package/dist/lib/interfaces/DomainTags.d.ts +228 -0
  6. package/dist/mailgun.node.js +2 -2
  7. package/dist/mailgun.node.js.LICENSE.txt +1 -1
  8. package/dist/mailgun.web.js +2 -2
  9. package/dist/mailgun.web.js.LICENSE.txt +1 -1
  10. package/docs/.nojekyll +1 -0
  11. package/docs/assets/highlight.css +127 -0
  12. package/docs/assets/icons.css +1043 -0
  13. package/docs/assets/{images/icons.png → icons.png} +0 -0
  14. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  15. package/docs/assets/main.js +52 -0
  16. package/docs/assets/search.js +1 -0
  17. package/docs/assets/style.css +1413 -0
  18. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  19. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  20. package/docs/classes/client.default.html +1 -0
  21. package/docs/classes/domains.Domain.html +1 -0
  22. package/docs/classes/domains.default.html +1 -0
  23. package/docs/classes/domainsCredentials.default.html +1 -0
  24. package/docs/classes/domainsTemplates.DomainTemplateItem.html +1 -0
  25. package/docs/classes/domainsTemplates.default.html +1 -0
  26. package/docs/classes/error.default.html +6 -0
  27. package/docs/classes/events.default.html +1 -0
  28. package/docs/classes/ip_pools.default.html +1 -0
  29. package/docs/classes/ips.default.html +1 -0
  30. package/docs/classes/lists.default.html +1 -0
  31. package/docs/classes/mailListMembers.default.html +1 -0
  32. package/docs/classes/messages.default.html +1 -0
  33. package/docs/classes/multipleValidation.default.html +1 -0
  34. package/docs/classes/request.default.html +1 -0
  35. package/docs/classes/routes.default.html +1 -0
  36. package/docs/classes/stats.default.html +1 -0
  37. package/docs/classes/suppressions.default.html +1 -0
  38. package/docs/classes/validate.default.html +1 -0
  39. package/docs/classes/webhooks.default.html +1 -0
  40. package/docs/enums/interfaces_DomainTemplates.Pages.html +1 -0
  41. package/docs/enums/interfaces_DomainTemplates.YesNo.html +1 -0
  42. package/docs/index.html +1140 -1308
  43. package/docs/interfaces/interfaces_APIErrorOptions.default.html +1 -0
  44. package/docs/interfaces/interfaces_ApiResponse.default.html +1 -0
  45. package/docs/interfaces/interfaces_DomainCredentials.CreatedUpdatedDomainCredentialsResponse.html +1 -0
  46. package/docs/interfaces/interfaces_DomainCredentials.DeletedDomainCredentialsResponse.html +1 -0
  47. package/docs/interfaces/interfaces_DomainCredentials.DomainCredentials.html +1 -0
  48. package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsItem.html +1 -0
  49. package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsList.html +1 -0
  50. package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsQuery.html +1 -0
  51. package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsResponseData.html +1 -0
  52. package/docs/interfaces/interfaces_DomainCredentials.DomainCredentialsResult.html +1 -0
  53. package/docs/interfaces/interfaces_DomainCredentials.IDomainCredentials.html +1 -0
  54. package/docs/interfaces/interfaces_DomainCredentials.UpdateDomainCredentialsData.html +1 -0
  55. package/docs/interfaces/interfaces_DomainTemplates.CreateDomainTemplateAPIResponse.html +1 -0
  56. package/docs/interfaces/interfaces_DomainTemplates.CreateDomainTemplateVersionAPIResponse.html +1 -0
  57. package/docs/interfaces/interfaces_DomainTemplates.CreateDomainTemplateVersionResult.html +1 -0
  58. package/docs/interfaces/interfaces_DomainTemplates.DomainTemplate.html +1 -0
  59. package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateData.html +1 -0
  60. package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateUpdateData.html +1 -0
  61. package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateUpdateVersionData.html +1 -0
  62. package/docs/interfaces/interfaces_DomainTemplates.DomainTemplateVersionData.html +1 -0
  63. package/docs/interfaces/interfaces_DomainTemplates.DomainTemplatesQuery.html +1 -0
  64. package/docs/interfaces/interfaces_DomainTemplates.GetDomainTemplateAPIResponse.html +1 -0
  65. package/docs/interfaces/interfaces_DomainTemplates.IDomainTemplatesClient.html +1 -0
  66. package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplateVersionsAPIResponse.html +1 -0
  67. package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplateVersionsResult.html +1 -0
  68. package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplatesAPIResponse.html +1 -0
  69. package/docs/interfaces/interfaces_DomainTemplates.ListDomainTemplatesResult.html +1 -0
  70. package/docs/interfaces/interfaces_DomainTemplates.MutateDomainTemplateVersionAPIResponse.html +1 -0
  71. package/docs/interfaces/interfaces_DomainTemplates.MutateDomainTemplateVersionResult.html +1 -0
  72. package/docs/interfaces/interfaces_DomainTemplates.NotificationAPIResponse.html +1 -0
  73. package/docs/interfaces/interfaces_DomainTemplates.NotificationResult.html +1 -0
  74. package/docs/interfaces/interfaces_DomainTemplates.ShortTemplateVersion.html +1 -0
  75. package/docs/interfaces/interfaces_DomainTemplates.TemplateQuery.html +1 -0
  76. package/docs/interfaces/interfaces_DomainTemplates.TemplateVersion.html +1 -0
  77. package/docs/interfaces/interfaces_DomainTemplates.UpdateOrDeleteDomainTemplateAPIResponse.html +1 -0
  78. package/docs/interfaces/interfaces_DomainTemplates.UpdateOrDeleteDomainTemplateResult.html +1 -0
  79. package/docs/interfaces/interfaces_DomainTracking.ClickTrackingInfo.html +1 -0
  80. package/docs/interfaces/interfaces_DomainTracking.DomainTrackingData.html +1 -0
  81. package/docs/interfaces/interfaces_DomainTracking.DomainTrackingResponse.html +1 -0
  82. package/docs/interfaces/interfaces_DomainTracking.OpenTrackingInfo.html +1 -0
  83. package/docs/interfaces/interfaces_DomainTracking.UnsubscribeTrackingInfo.html +1 -0
  84. package/docs/interfaces/interfaces_DomainTracking.UpdateDomainTrackingResponse.html +1 -0
  85. package/docs/interfaces/interfaces_DomainTracking.UpdatedOpenTracking.html +1 -0
  86. package/docs/interfaces/interfaces_Domains.ConnectionSettings.html +1 -0
  87. package/docs/interfaces/interfaces_Domains.ConnectionSettingsResponse.html +1 -0
  88. package/docs/interfaces/interfaces_Domains.DKIMAuthorityInfo.html +1 -0
  89. package/docs/interfaces/interfaces_Domains.DKIMSelectorInfo.html +1 -0
  90. package/docs/interfaces/interfaces_Domains.DNSRecord.html +1 -0
  91. package/docs/interfaces/interfaces_Domains.DestroyedDomainResponse.html +1 -0
  92. package/docs/interfaces/interfaces_Domains.DomainData.html +1 -0
  93. package/docs/interfaces/interfaces_Domains.DomainInfo.html +1 -0
  94. package/docs/interfaces/interfaces_Domains.DomainListResponseData.html +1 -0
  95. package/docs/interfaces/interfaces_Domains.DomainResponseData.html +1 -0
  96. package/docs/interfaces/interfaces_Domains.DomainShortData.html +1 -0
  97. package/docs/interfaces/interfaces_Domains.DomainsListItem.html +1 -0
  98. package/docs/interfaces/interfaces_Domains.DomainsQuery.html +1 -0
  99. package/docs/interfaces/interfaces_Domains.MessageResponse.html +1 -0
  100. package/docs/interfaces/interfaces_Domains.ReplacementForPool.html +1 -0
  101. package/docs/interfaces/interfaces_Domains.UpdatedConnectionSettings.html +1 -0
  102. package/docs/interfaces/interfaces_Domains.UpdatedConnectionSettingsRes.html +1 -0
  103. package/docs/interfaces/interfaces_Domains.UpdatedDKIMAuthority.html +1 -0
  104. package/docs/interfaces/interfaces_Domains.UpdatedDKIMAuthorityResponse.html +1 -0
  105. package/docs/interfaces/interfaces_Domains.UpdatedDKIMSelectorResponse.html +1 -0
  106. package/docs/interfaces/interfaces_Domains.UpdatedWebPrefix.html +1 -0
  107. package/docs/interfaces/interfaces_Domains.UpdatedWebPrefixResponse.html +1 -0
  108. package/docs/interfaces/interfaces_Domains.WebPrefixInfo.html +1 -0
  109. package/docs/interfaces/interfaces_Events.DomainEvent.html +1 -0
  110. package/docs/interfaces/interfaces_Events.EventsList.html +1 -0
  111. package/docs/interfaces/interfaces_Events.EventsPage.html +1 -0
  112. package/docs/interfaces/interfaces_Events.EventsResponse.html +1 -0
  113. package/docs/interfaces/interfaces_Events.PagesList.html +1 -0
  114. package/docs/interfaces/interfaces_Events.PagesListAccumulator.html +1 -0
  115. package/docs/interfaces/interfaces_Events.ParsedPage.html +1 -0
  116. package/docs/interfaces/interfaces_Events.ParsedPagesList.html +1 -0
  117. package/docs/interfaces/interfaces_IFormData.IFormDataOptions.html +1 -0
  118. package/docs/interfaces/interfaces_IFormData.InputFormData.html +1 -0
  119. package/docs/interfaces/interfaces_IpPools.IpPool.html +1 -0
  120. package/docs/interfaces/interfaces_IpPools.IpPoolListResponse.html +1 -0
  121. package/docs/interfaces/interfaces_IpPools.IpPoolUpdateData.html +1 -0
  122. package/docs/interfaces/interfaces_Ips.IpData.html +1 -0
  123. package/docs/interfaces/interfaces_Ips.IpsListResponseBody.html +1 -0
  124. package/docs/interfaces/interfaces_MultipleValidation.CanceledMultipleValidationJob.html +1 -0
  125. package/docs/interfaces/interfaces_MultipleValidation.CreatedMultipleValidationJob.html +1 -0
  126. package/docs/interfaces/interfaces_MultipleValidation.IMultipleValidationClient.html +1 -0
  127. package/docs/interfaces/interfaces_MultipleValidation.MultipleValidationJob.html +1 -0
  128. package/docs/interfaces/interfaces_MultipleValidation.MultipleValidationJobsListResponse.html +1 -0
  129. package/docs/interfaces/interfaces_MultipleValidation.MultipleValidationJobsListResult.html +1 -0
  130. package/docs/interfaces/interfaces_MultipleValidation.PagesList.html +1 -0
  131. package/docs/interfaces/interfaces_Options.default.html +1 -0
  132. package/docs/interfaces/interfaces_RequestOptions.default.html +1 -0
  133. package/docs/interfaces/interfaces_StatsOptions.Stat.html +1 -0
  134. package/docs/interfaces/interfaces_StatsOptions.StatsOptions.html +1 -0
  135. package/docs/interfaces/interfaces_StatsOptions.StatsQuery.html +1 -0
  136. package/docs/interfaces/interfaces_Supressions.BounceData.html +1 -0
  137. package/docs/interfaces/interfaces_Supressions.ComplaintData.html +1 -0
  138. package/docs/interfaces/interfaces_Supressions.UnsubscribeData.html +1 -0
  139. package/docs/interfaces/interfaces_Supressions.WhiteListData.html +1 -0
  140. package/docs/interfaces/interfaces_Validate.ValidationResponse.html +1 -0
  141. package/docs/interfaces/interfaces_Validate.ValidationResult.html +1 -0
  142. package/docs/interfaces/interfaces_Webhooks.APIWebhook.html +1 -0
  143. package/docs/interfaces/interfaces_Webhooks.ValidationResponse.html +1 -0
  144. package/docs/interfaces/interfaces_Webhooks.WebhookList.html +1 -0
  145. package/docs/interfaces/interfaces_Webhooks.WebhookResponse.html +1 -0
  146. package/docs/interfaces/interfaces_Webhooks.WebhookResponseBody.html +1 -0
  147. package/docs/interfaces/interfaces_Webhooks.WebhooksQuery.html +1 -0
  148. package/docs/interfaces/interfaces_lists.CreateUpdateList.html +1 -0
  149. package/docs/interfaces/interfaces_lists.DestroyedList.html +1 -0
  150. package/docs/interfaces/interfaces_lists.ListsQuery.html +1 -0
  151. package/docs/interfaces/interfaces_lists.MailingList.html +1 -0
  152. package/docs/interfaces/interfaces_mailListMembers.CreateUpdateMailListMembers.html +1 -0
  153. package/docs/interfaces/interfaces_mailListMembers.CreateUpdateMailListMembersReq.html +1 -0
  154. package/docs/interfaces/interfaces_mailListMembers.DeletedMember.html +1 -0
  155. package/docs/interfaces/interfaces_mailListMembers.IMailListsMembers.html +1 -0
  156. package/docs/interfaces/interfaces_mailListMembers.MailListMember.html +1 -0
  157. package/docs/interfaces/interfaces_mailListMembers.MailListMembersQuery.html +1 -0
  158. package/docs/interfaces/interfaces_mailListMembers.MultipleMembersData.html +1 -0
  159. package/docs/interfaces/interfaces_mailListMembers.MultipleMembersReqData.html +1 -0
  160. package/docs/interfaces/interfaces_mailListMembers.NewMultipleMembersResponse.html +1 -0
  161. package/docs/interfaces/interfaces_routes.CreateUpdateRouteData.html +1 -0
  162. package/docs/interfaces/interfaces_routes.DestroyRouteResponse.html +1 -0
  163. package/docs/interfaces/interfaces_routes.Route.html +1 -0
  164. package/docs/interfaces/interfaces_routes.RoutesListQuery.html +1 -0
  165. package/docs/interfaces/interfaces_routes.UpdateRouteResponse.html +1 -0
  166. package/docs/modules/client.html +1 -0
  167. package/docs/modules/domains.html +1 -0
  168. package/docs/modules/domainsCredentials.html +1 -0
  169. package/docs/modules/domainsTemplates.html +1 -0
  170. package/docs/modules/error.html +1 -0
  171. package/docs/modules/events.html +1 -0
  172. package/docs/modules/interfaces_APIErrorOptions.html +1 -0
  173. package/docs/modules/interfaces_ApiResponse.html +1 -0
  174. package/docs/modules/interfaces_DomainCredentials.html +1 -0
  175. package/docs/modules/interfaces_DomainTemplates.html +1 -0
  176. package/docs/modules/interfaces_DomainTracking.html +1 -0
  177. package/docs/modules/interfaces_Domains.html +1 -0
  178. package/docs/modules/interfaces_Events.html +1 -0
  179. package/docs/modules/interfaces_IFormData.html +1 -0
  180. package/docs/modules/interfaces_IpPools.html +1 -0
  181. package/docs/modules/interfaces_Ips.html +1 -0
  182. package/docs/modules/interfaces_MultipleValidation.html +1 -0
  183. package/docs/modules/interfaces_Options.html +1 -0
  184. package/docs/modules/interfaces_RequestOptions.html +1 -0
  185. package/docs/modules/interfaces_StatsOptions.html +1 -0
  186. package/docs/modules/interfaces_Supressions.html +1 -0
  187. package/docs/modules/interfaces_Validate.html +1 -0
  188. package/docs/modules/interfaces_Webhooks.html +1 -0
  189. package/docs/modules/interfaces_lists.html +1 -0
  190. package/docs/modules/interfaces_mailListMembers.html +1 -0
  191. package/docs/modules/interfaces_routes.html +1 -0
  192. package/docs/modules/ip_pools.html +1 -0
  193. package/docs/modules/ips.html +1 -0
  194. package/docs/modules/lists.html +1 -0
  195. package/docs/modules/mailListMembers.html +1 -0
  196. package/docs/modules/messages.html +1 -0
  197. package/docs/modules/multipleValidation.html +1 -0
  198. package/docs/modules/request.html +1 -0
  199. package/docs/modules/routes.html +1 -0
  200. package/docs/modules/stats.html +1 -0
  201. package/docs/modules/suppressions.html +1 -0
  202. package/docs/modules/validate.html +1 -0
  203. package/docs/modules/webhooks.html +1 -0
  204. package/docs/modules.html +1 -0
  205. package/lib/client.ts +8 -1
  206. package/lib/domains.ts +7 -2
  207. package/lib/domainsTags.ts +165 -0
  208. package/lib/interfaces/DomainTags.ts +262 -0
  209. package/package.json +3 -3
  210. package/test/domains.test.ts +8 -1
  211. package/test/domainsTags.test.ts +345 -0
  212. package/tsconfig.json +2 -2
  213. package/docs/assets/css/main.css +0 -1
  214. package/docs/assets/js/main.js +0 -51
  215. package/docs/assets/js/search.json +0 -1
  216. package/docs/classes/_index_.mailgun.html +0 -294
  217. package/docs/classes/_lib_client_.client.html +0 -405
  218. package/docs/classes/_lib_domains_.domain.html +0 -422
  219. package/docs/classes/_lib_domains_.domainclient.html +0 -620
  220. package/docs/classes/_lib_error_.apierror.html +0 -362
  221. package/docs/classes/_lib_events_.eventclient.html +0 -465
  222. package/docs/classes/_lib_messages_.messagesclient.html +0 -327
  223. package/docs/classes/_lib_parse_.parseclient.html +0 -295
  224. package/docs/classes/_lib_request_.request.html +0 -698
  225. package/docs/classes/_lib_routes_.routesclient.html +0 -403
  226. package/docs/classes/_lib_stats_.stats.html +0 -301
  227. package/docs/classes/_lib_stats_.statsclient.html +0 -357
  228. package/docs/classes/_lib_suppressions_.bounce.html +0 -327
  229. package/docs/classes/_lib_suppressions_.complaint.html +0 -299
  230. package/docs/classes/_lib_suppressions_.suppressionclient.html +0 -599
  231. package/docs/classes/_lib_suppressions_.unsubscribe.html +0 -313
  232. package/docs/classes/_lib_validate_.validateclient.html +0 -292
  233. package/docs/classes/_lib_webhooks_.webhook.html +0 -281
  234. package/docs/classes/_lib_webhooks_.webhookclient.html +0 -539
  235. package/docs/globals.html +0 -199
  236. package/docs/interfaces/_lib_domains_.domaindata.html +0 -352
  237. package/docs/interfaces/_lib_interfaces_apierroroptions_.apierroroptions.html +0 -284
  238. package/docs/interfaces/_lib_interfaces_options_.options.html +0 -267
  239. package/docs/interfaces/_lib_interfaces_requestoptions_.requestoptions.html +0 -285
  240. package/docs/interfaces/_lib_interfaces_statsoptions_.statsoptions.html +0 -262
  241. package/docs/interfaces/_lib_interfaces_supressions_.bouncedata.html +0 -268
  242. package/docs/interfaces/_lib_interfaces_supressions_.complaintdata.html +0 -240
  243. package/docs/interfaces/_lib_interfaces_supressions_.unsubscribedata.html +0 -254
  244. package/docs/modules/_index_.html +0 -186
  245. package/docs/modules/_lib_client_.html +0 -208
  246. package/docs/modules/_lib_domains_.html +0 -199
  247. package/docs/modules/_lib_error_.html +0 -186
  248. package/docs/modules/_lib_events_.html +0 -250
  249. package/docs/modules/_lib_interfaces_apierroroptions_.html +0 -186
  250. package/docs/modules/_lib_interfaces_options_.html +0 -186
  251. package/docs/modules/_lib_interfaces_requestoptions_.html +0 -186
  252. package/docs/modules/_lib_interfaces_statsoptions_.html +0 -186
  253. package/docs/modules/_lib_interfaces_supressions_.html +0 -194
  254. package/docs/modules/_lib_messages_.html +0 -186
  255. package/docs/modules/_lib_parse_.html +0 -186
  256. package/docs/modules/_lib_request_.html +0 -259
  257. package/docs/modules/_lib_routes_.html +0 -186
  258. package/docs/modules/_lib_stats_.html +0 -190
  259. package/docs/modules/_lib_suppressions_.html +0 -262
  260. package/docs/modules/_lib_validate_.html +0 -186
  261. package/docs/modules/_lib_webhooks_.html +0 -190
  262. package/docs/modules/_webpack_config_.html +0 -227
  263. package/docs/modules/_webpack_release_config_.html +0 -227
@@ -1,281 +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>Webhook | 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_webhooks_.html">&quot;lib/webhooks&quot;</a>
60
- </li>
61
- <li>
62
- <a href="_lib_webhooks_.webhook.html">Webhook</a>
63
- </li>
64
- </ul>
65
- <h1>Class Webhook</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">Webhook</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 tsd-is-not-exported">
85
- <h3>Constructors</h3>
86
- <ul class="tsd-index-list">
87
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported"><a href="_lib_webhooks_.webhook.html#constructor" class="tsd-kind-icon">constructor</a></li>
88
- </ul>
89
- </section>
90
- <section class="tsd-index-section tsd-is-not-exported">
91
- <h3>Properties</h3>
92
- <ul class="tsd-index-list">
93
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="_lib_webhooks_.webhook.html#id" class="tsd-kind-icon">id</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="_lib_webhooks_.webhook.html#url" class="tsd-kind-icon">url</a></li>
95
- </ul>
96
- </section>
97
- </div>
98
- </section>
99
- </section>
100
- <section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
101
- <h2>Constructors</h2>
102
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
103
- <a name="constructor" class="tsd-anchor"></a>
104
- <h3>constructor</h3>
105
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
106
- <li class="tsd-signature tsd-kind-icon">new <wbr>Webhook<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>url<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-symbol">: </span><a href="_lib_webhooks_.webhook.html" class="tsd-signature-type">Webhook</a></li>
107
- </ul>
108
- <ul class="tsd-descriptions">
109
- <li class="tsd-description">
110
- <aside class="tsd-sources">
111
- <ul>
112
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/webhooks.ts#L6">lib/webhooks.ts:6</a></li>
113
- </ul>
114
- </aside>
115
- <h4 class="tsd-parameters-title">Parameters</h4>
116
- <ul class="tsd-parameters">
117
- <li>
118
- <h5>id: <span class="tsd-signature-type">string</span></h5>
119
- </li>
120
- <li>
121
- <h5>data: <span class="tsd-signature-symbol">{ </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
122
- <ul class="tsd-parameters">
123
- <li class="tsd-parameter">
124
- <h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
125
- </li>
126
- </ul>
127
- </li>
128
- </ul>
129
- <h4 class="tsd-returns-title">Returns <a href="_lib_webhooks_.webhook.html" class="tsd-signature-type">Webhook</a></h4>
130
- </li>
131
- </ul>
132
- </section>
133
- </section>
134
- <section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
135
- <h2>Properties</h2>
136
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
137
- <a name="id" class="tsd-anchor"></a>
138
- <h3>id</h3>
139
- <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
140
- <aside class="tsd-sources">
141
- <ul>
142
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/webhooks.ts#L5">lib/webhooks.ts:5</a></li>
143
- </ul>
144
- </aside>
145
- </section>
146
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
147
- <a name="url" class="tsd-anchor"></a>
148
- <h3>url</h3>
149
- <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
150
- <aside class="tsd-sources">
151
- <ul>
152
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/webhooks.ts#L6">lib/webhooks.ts:6</a></li>
153
- </ul>
154
- </aside>
155
- </section>
156
- </section>
157
- </div>
158
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
159
- <nav class="tsd-navigation primary">
160
- <ul>
161
- <li class="globals ">
162
- <a href="../globals.html"><em>Globals</em></a>
163
- </li>
164
- <li class=" tsd-kind-module">
165
- <a href="../modules/_index_.html">&quot;index&quot;</a>
166
- </li>
167
- <li class=" tsd-kind-module">
168
- <a href="../modules/_lib_client_.html">&quot;lib/client&quot;</a>
169
- </li>
170
- <li class=" tsd-kind-module">
171
- <a href="../modules/_lib_domains_.html">&quot;lib/domains&quot;</a>
172
- </li>
173
- <li class=" tsd-kind-module">
174
- <a href="../modules/_lib_error_.html">&quot;lib/error&quot;</a>
175
- </li>
176
- <li class=" tsd-kind-module">
177
- <a href="../modules/_lib_events_.html">&quot;lib/events&quot;</a>
178
- </li>
179
- <li class=" tsd-kind-module">
180
- <a href="../modules/_lib_interfaces_apierroroptions_.html">&quot;lib/interfaces/APIError<wbr>Options&quot;</a>
181
- </li>
182
- <li class=" tsd-kind-module">
183
- <a href="../modules/_lib_interfaces_options_.html">&quot;lib/interfaces/<wbr>Options&quot;</a>
184
- </li>
185
- <li class=" tsd-kind-module">
186
- <a href="../modules/_lib_interfaces_requestoptions_.html">&quot;lib/interfaces/<wbr>Request<wbr>Options&quot;</a>
187
- </li>
188
- <li class=" tsd-kind-module">
189
- <a href="../modules/_lib_interfaces_statsoptions_.html">&quot;lib/interfaces/<wbr>Stats<wbr>Options&quot;</a>
190
- </li>
191
- <li class=" tsd-kind-module">
192
- <a href="../modules/_lib_interfaces_supressions_.html">&quot;lib/interfaces/<wbr>Supressions&quot;</a>
193
- </li>
194
- <li class=" tsd-kind-module">
195
- <a href="../modules/_lib_messages_.html">&quot;lib/messages&quot;</a>
196
- </li>
197
- <li class=" tsd-kind-module">
198
- <a href="../modules/_lib_parse_.html">&quot;lib/parse&quot;</a>
199
- </li>
200
- <li class=" tsd-kind-module">
201
- <a href="../modules/_lib_request_.html">&quot;lib/request&quot;</a>
202
- </li>
203
- <li class=" tsd-kind-module">
204
- <a href="../modules/_lib_routes_.html">&quot;lib/routes&quot;</a>
205
- </li>
206
- <li class=" tsd-kind-module">
207
- <a href="../modules/_lib_stats_.html">&quot;lib/stats&quot;</a>
208
- </li>
209
- <li class=" tsd-kind-module">
210
- <a href="../modules/_lib_suppressions_.html">&quot;lib/suppressions&quot;</a>
211
- </li>
212
- <li class=" tsd-kind-module">
213
- <a href="../modules/_lib_validate_.html">&quot;lib/validate&quot;</a>
214
- </li>
215
- <li class="current tsd-kind-module">
216
- <a href="../modules/_lib_webhooks_.html">&quot;lib/webhooks&quot;</a>
217
- </li>
218
- <li class=" tsd-kind-module">
219
- <a href="../modules/_webpack_config_.html">&quot;webpack.config&quot;</a>
220
- </li>
221
- <li class=" tsd-kind-module">
222
- <a href="../modules/_webpack_release_config_.html">&quot;webpack.release.config&quot;</a>
223
- </li>
224
- </ul>
225
- </nav>
226
- <nav class="tsd-navigation secondary menu-sticky">
227
- <ul class="before-current">
228
- </ul>
229
- <ul class="current">
230
- <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-not-exported">
231
- <a href="_lib_webhooks_.webhook.html" class="tsd-kind-icon">Webhook</a>
232
- <ul>
233
- <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
234
- <a href="_lib_webhooks_.webhook.html#constructor" class="tsd-kind-icon">constructor</a>
235
- </li>
236
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
237
- <a href="_lib_webhooks_.webhook.html#id" class="tsd-kind-icon">id</a>
238
- </li>
239
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
240
- <a href="_lib_webhooks_.webhook.html#url" class="tsd-kind-icon">url</a>
241
- </li>
242
- </ul>
243
- </li>
244
- </ul>
245
- <ul class="after-current">
246
- <li class=" tsd-kind-class tsd-parent-kind-module">
247
- <a href="_lib_webhooks_.webhookclient.html" class="tsd-kind-icon">Webhook<wbr>Client</a>
248
- </li>
249
- </ul>
250
- </nav>
251
- </div>
252
- </div>
253
- </div>
254
- <footer class="with-border-bottom">
255
- <div class="container">
256
- <h2>Legend</h2>
257
- <div class="tsd-legend-group">
258
- <ul class="tsd-legend">
259
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
260
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
261
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
262
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
263
- </ul>
264
- <ul class="tsd-legend">
265
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
266
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
267
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
268
- </ul>
269
- <ul class="tsd-legend">
270
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
271
- </ul>
272
- </div>
273
- </div>
274
- </footer>
275
- <div class="container tsd-generator">
276
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
277
- </div>
278
- <div class="overlay"></div>
279
- <script src="../assets/js/main.js"></script>
280
- </body>
281
- </html>