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
package/docs/classes/_lib_request_.request.html DELETED
@@ -1,698 +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>Request | 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_request_.html">&quot;lib/request&quot;</a>
60
- </li>
61
- <li>
62
- <a href="_lib_request_.request.html">Request</a>
63
- </li>
64
- </ul>
65
- <h1>Class Request</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">Request</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_request_.request.html#constructor" class="tsd-kind-icon">constructor</a></li>
88
- </ul>
89
- </section>
90
- <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
91
- <h3>Properties</h3>
92
- <ul class="tsd-index-list">
93
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_request_.request.html#formdata" class="tsd-kind-icon">form<wbr>Data</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_request_.request.html#headers" class="tsd-kind-icon">headers</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_request_.request.html#key" class="tsd-kind-icon">key</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_request_.request.html#url" class="tsd-kind-icon">url</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_request_.request.html#username" class="tsd-kind-icon">username</a></li>
98
- </ul>
99
- </section>
100
- <section class="tsd-index-section ">
101
- <h3>Methods</h3>
102
- <ul class="tsd-index-list">
103
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#command" class="tsd-kind-icon">command</a></li>
104
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#delete" class="tsd-kind-icon">delete</a></li>
105
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#get" class="tsd-kind-icon">get</a></li>
106
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#head" class="tsd-kind-icon">head</a></li>
107
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#options" class="tsd-kind-icon">options</a></li>
108
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#patch" class="tsd-kind-icon">patch</a></li>
109
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#post" class="tsd-kind-icon">post</a></li>
110
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#postmulti" class="tsd-kind-icon">post<wbr>Multi</a></li>
111
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#put" class="tsd-kind-icon">put</a></li>
112
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#query" class="tsd-kind-icon">query</a></li>
113
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_request_.request.html#request" class="tsd-kind-icon">request</a></li>
114
- </ul>
115
- </section>
116
- </div>
117
- </section>
118
- </section>
119
- <section class="tsd-panel-group tsd-member-group ">
120
- <h2>Constructors</h2>
121
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
122
- <a name="constructor" class="tsd-anchor"></a>
123
- <h3>constructor</h3>
124
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
125
- <li class="tsd-signature tsd-kind-icon">new <wbr>Request<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_interfaces_requestoptions_.requestoptions.html" class="tsd-signature-type">RequestOptions</a>, formData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_request_.request.html" class="tsd-signature-type">Request</a></li>
126
- </ul>
127
- <ul class="tsd-descriptions">
128
- <li class="tsd-description">
129
- <aside class="tsd-sources">
130
- <ul>
131
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L35">lib/request.ts:35</a></li>
132
- </ul>
133
- </aside>
134
- <h4 class="tsd-parameters-title">Parameters</h4>
135
- <ul class="tsd-parameters">
136
- <li>
137
- <h5>options: <a href="../interfaces/_lib_interfaces_requestoptions_.requestoptions.html" class="tsd-signature-type">RequestOptions</a></h5>
138
- </li>
139
- <li>
140
- <h5>formData: <span class="tsd-signature-type">FormData</span></h5>
141
- </li>
142
- </ul>
143
- <h4 class="tsd-returns-title">Returns <a href="_lib_request_.request.html" class="tsd-signature-type">Request</a></h4>
144
- </li>
145
- </ul>
146
- </section>
147
- </section>
148
- <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
149
- <h2>Properties</h2>
150
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
151
- <a name="formdata" class="tsd-anchor"></a>
152
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> form<wbr>Data</h3>
153
- <div class="tsd-signature tsd-kind-icon">form<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FormData</span></div>
154
- <aside class="tsd-sources">
155
- <ul>
156
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L35">lib/request.ts:35</a></li>
157
- </ul>
158
- </aside>
159
- </section>
160
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
161
- <a name="headers" class="tsd-anchor"></a>
162
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> headers</h3>
163
- <div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
164
- <aside class="tsd-sources">
165
- <ul>
166
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L34">lib/request.ts:34</a></li>
167
- </ul>
168
- </aside>
169
- </section>
170
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
171
- <a name="key" class="tsd-anchor"></a>
172
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> key</h3>
173
- <div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
174
- <aside class="tsd-sources">
175
- <ul>
176
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L32">lib/request.ts:32</a></li>
177
- </ul>
178
- </aside>
179
- </section>
180
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
181
- <a name="url" class="tsd-anchor"></a>
182
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> url</h3>
183
- <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
184
- <aside class="tsd-sources">
185
- <ul>
186
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L33">lib/request.ts:33</a></li>
187
- </ul>
188
- </aside>
189
- </section>
190
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
191
- <a name="username" class="tsd-anchor"></a>
192
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> username</h3>
193
- <div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
194
- <aside class="tsd-sources">
195
- <ul>
196
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L31">lib/request.ts:31</a></li>
197
- </ul>
198
- </aside>
199
- </section>
200
- </section>
201
- <section class="tsd-panel-group tsd-member-group ">
202
- <h2>Methods</h2>
203
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
204
- <a name="command" class="tsd-anchor"></a>
205
- <h3>command</h3>
206
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
207
- <li class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<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>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
208
- </ul>
209
- <ul class="tsd-descriptions">
210
- <li class="tsd-description">
211
- <aside class="tsd-sources">
212
- <ul>
213
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L82">lib/request.ts:82</a></li>
214
- </ul>
215
- </aside>
216
- <h4 class="tsd-parameters-title">Parameters</h4>
217
- <ul class="tsd-parameters">
218
- <li>
219
- <h5>method: <span class="tsd-signature-type">string</span></h5>
220
- </li>
221
- <li>
222
- <h5>url: <span class="tsd-signature-type">string</span></h5>
223
- </li>
224
- <li>
225
- <h5>data: <span class="tsd-signature-type">any</span></h5>
226
- </li>
227
- <li>
228
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
229
- </li>
230
- </ul>
231
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
232
- </li>
233
- </ul>
234
- </section>
235
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
236
- <a name="delete" class="tsd-anchor"></a>
237
- <h3>delete</h3>
238
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
239
- <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>url<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>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
240
- </ul>
241
- <ul class="tsd-descriptions">
242
- <li class="tsd-description">
243
- <aside class="tsd-sources">
244
- <ul>
245
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L155">lib/request.ts:155</a></li>
246
- </ul>
247
- </aside>
248
- <h4 class="tsd-parameters-title">Parameters</h4>
249
- <ul class="tsd-parameters">
250
- <li>
251
- <h5>url: <span class="tsd-signature-type">string</span></h5>
252
- </li>
253
- <li>
254
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
255
- </li>
256
- <li>
257
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
258
- </li>
259
- </ul>
260
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
261
- </li>
262
- </ul>
263
- </section>
264
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
265
- <a name="get" class="tsd-anchor"></a>
266
- <h3>get</h3>
267
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
268
- <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
269
- </ul>
270
- <ul class="tsd-descriptions">
271
- <li class="tsd-description">
272
- <aside class="tsd-sources">
273
- <ul>
274
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L91">lib/request.ts:91</a></li>
275
- </ul>
276
- </aside>
277
- <h4 class="tsd-parameters-title">Parameters</h4>
278
- <ul class="tsd-parameters">
279
- <li>
280
- <h5>url: <span class="tsd-signature-type">string</span></h5>
281
- </li>
282
- <li>
283
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> query: <span class="tsd-signature-type">any</span></h5>
284
- </li>
285
- <li>
286
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
287
- </li>
288
- </ul>
289
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
290
- </li>
291
- </ul>
292
- </section>
293
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
294
- <a name="head" class="tsd-anchor"></a>
295
- <h3>head</h3>
296
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
297
- <li class="tsd-signature tsd-kind-icon">head<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
298
- </ul>
299
- <ul class="tsd-descriptions">
300
- <li class="tsd-description">
301
- <aside class="tsd-sources">
302
- <ul>
303
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L95">lib/request.ts:95</a></li>
304
- </ul>
305
- </aside>
306
- <h4 class="tsd-parameters-title">Parameters</h4>
307
- <ul class="tsd-parameters">
308
- <li>
309
- <h5>url: <span class="tsd-signature-type">string</span></h5>
310
- </li>
311
- <li>
312
- <h5>query: <span class="tsd-signature-type">any</span></h5>
313
- </li>
314
- <li>
315
- <h5>options: <span class="tsd-signature-type">any</span></h5>
316
- </li>
317
- </ul>
318
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
319
- </li>
320
- </ul>
321
- </section>
322
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
323
- <a name="options" class="tsd-anchor"></a>
324
- <h3>options</h3>
325
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
326
- <li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
327
- </ul>
328
- <ul class="tsd-descriptions">
329
- <li class="tsd-description">
330
- <aside class="tsd-sources">
331
- <ul>
332
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L99">lib/request.ts:99</a></li>
333
- </ul>
334
- </aside>
335
- <h4 class="tsd-parameters-title">Parameters</h4>
336
- <ul class="tsd-parameters">
337
- <li>
338
- <h5>url: <span class="tsd-signature-type">string</span></h5>
339
- </li>
340
- <li>
341
- <h5>query: <span class="tsd-signature-type">any</span></h5>
342
- </li>
343
- <li>
344
- <h5>options: <span class="tsd-signature-type">any</span></h5>
345
- </li>
346
- </ul>
347
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
348
- </li>
349
- </ul>
350
- </section>
351
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
352
- <a name="patch" class="tsd-anchor"></a>
353
- <h3>patch</h3>
354
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
355
- <li class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">(</span>url<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>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
356
- </ul>
357
- <ul class="tsd-descriptions">
358
- <li class="tsd-description">
359
- <aside class="tsd-sources">
360
- <ul>
361
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L151">lib/request.ts:151</a></li>
362
- </ul>
363
- </aside>
364
- <h4 class="tsd-parameters-title">Parameters</h4>
365
- <ul class="tsd-parameters">
366
- <li>
367
- <h5>url: <span class="tsd-signature-type">string</span></h5>
368
- </li>
369
- <li>
370
- <h5>data: <span class="tsd-signature-type">any</span></h5>
371
- </li>
372
- <li>
373
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
374
- </li>
375
- </ul>
376
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
377
- </li>
378
- </ul>
379
- </section>
380
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
381
- <a name="post" class="tsd-anchor"></a>
382
- <h3>post</h3>
383
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
384
- <li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>url<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>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
385
- </ul>
386
- <ul class="tsd-descriptions">
387
- <li class="tsd-description">
388
- <aside class="tsd-sources">
389
- <ul>
390
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L103">lib/request.ts:103</a></li>
391
- </ul>
392
- </aside>
393
- <h4 class="tsd-parameters-title">Parameters</h4>
394
- <ul class="tsd-parameters">
395
- <li>
396
- <h5>url: <span class="tsd-signature-type">string</span></h5>
397
- </li>
398
- <li>
399
- <h5>data: <span class="tsd-signature-type">any</span></h5>
400
- </li>
401
- <li>
402
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</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="postmulti" class="tsd-anchor"></a>
411
- <h3>post<wbr>Multi</h3>
412
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
413
- <li class="tsd-signature tsd-kind-icon">post<wbr>Multi<span class="tsd-signature-symbol">(</span>url<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</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/request.ts#L107">lib/request.ts:107</a></li>
420
- </ul>
421
- </aside>
422
- <h4 class="tsd-parameters-title">Parameters</h4>
423
- <ul class="tsd-parameters">
424
- <li>
425
- <h5>url: <span class="tsd-signature-type">string</span></h5>
426
- </li>
427
- <li>
428
- <h5>data: <span class="tsd-signature-type">any</span></h5>
429
- </li>
430
- </ul>
431
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
432
- </li>
433
- </ul>
434
- </section>
435
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
436
- <a name="put" class="tsd-anchor"></a>
437
- <h3>put</h3>
438
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
439
- <li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>url<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>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
440
- </ul>
441
- <ul class="tsd-descriptions">
442
- <li class="tsd-description">
443
- <aside class="tsd-sources">
444
- <ul>
445
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L147">lib/request.ts:147</a></li>
446
- </ul>
447
- </aside>
448
- <h4 class="tsd-parameters-title">Parameters</h4>
449
- <ul class="tsd-parameters">
450
- <li>
451
- <h5>url: <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
- <li>
457
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
458
- </li>
459
- </ul>
460
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
461
- </li>
462
- </ul>
463
- </section>
464
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
465
- <a name="query" class="tsd-anchor"></a>
466
- <h3>query</h3>
467
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
468
- <li class="tsd-signature tsd-kind-icon">query<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
469
- </ul>
470
- <ul class="tsd-descriptions">
471
- <li class="tsd-description">
472
- <aside class="tsd-sources">
473
- <ul>
474
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L78">lib/request.ts:78</a></li>
475
- </ul>
476
- </aside>
477
- <h4 class="tsd-parameters-title">Parameters</h4>
478
- <ul class="tsd-parameters">
479
- <li>
480
- <h5>method: <span class="tsd-signature-type">string</span></h5>
481
- </li>
482
- <li>
483
- <h5>url: <span class="tsd-signature-type">string</span></h5>
484
- </li>
485
- <li>
486
- <h5>query: <span class="tsd-signature-type">any</span></h5>
487
- </li>
488
- <li>
489
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
490
- </li>
491
- </ul>
492
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
493
- </li>
494
- </ul>
495
- </section>
496
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
497
- <a name="request" class="tsd-anchor"></a>
498
- <h3>request</h3>
499
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
500
- <li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<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">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
501
- </ul>
502
- <ul class="tsd-descriptions">
503
- <li class="tsd-description">
504
- <aside class="tsd-sources">
505
- <ul>
506
- <li>Defined in <a href="https://github.com/andrii-yelis/mailgun-js/blob/ad9f2c7/lib/request.ts#L45">lib/request.ts:45</a></li>
507
- </ul>
508
- </aside>
509
- <h4 class="tsd-parameters-title">Parameters</h4>
510
- <ul class="tsd-parameters">
511
- <li>
512
- <h5>method: <span class="tsd-signature-type">string</span></h5>
513
- </li>
514
- <li>
515
- <h5>url: <span class="tsd-signature-type">string</span></h5>
516
- </li>
517
- <li>
518
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
519
- </li>
520
- </ul>
521
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
522
- </li>
523
- </ul>
524
- </section>
525
- </section>
526
- </div>
527
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
528
- <nav class="tsd-navigation primary">
529
- <ul>
530
- <li class="globals ">
531
- <a href="../globals.html"><em>Globals</em></a>
532
- </li>
533
- <li class=" tsd-kind-module">
534
- <a href="../modules/_index_.html">&quot;index&quot;</a>
535
- </li>
536
- <li class=" tsd-kind-module">
537
- <a href="../modules/_lib_client_.html">&quot;lib/client&quot;</a>
538
- </li>
539
- <li class=" tsd-kind-module">
540
- <a href="../modules/_lib_domains_.html">&quot;lib/domains&quot;</a>
541
- </li>
542
- <li class=" tsd-kind-module">
543
- <a href="../modules/_lib_error_.html">&quot;lib/error&quot;</a>
544
- </li>
545
- <li class=" tsd-kind-module">
546
- <a href="../modules/_lib_events_.html">&quot;lib/events&quot;</a>
547
- </li>
548
- <li class=" tsd-kind-module">
549
- <a href="../modules/_lib_interfaces_apierroroptions_.html">&quot;lib/interfaces/APIError<wbr>Options&quot;</a>
550
- </li>
551
- <li class=" tsd-kind-module">
552
- <a href="../modules/_lib_interfaces_options_.html">&quot;lib/interfaces/<wbr>Options&quot;</a>
553
- </li>
554
- <li class=" tsd-kind-module">
555
- <a href="../modules/_lib_interfaces_requestoptions_.html">&quot;lib/interfaces/<wbr>Request<wbr>Options&quot;</a>
556
- </li>
557
- <li class=" tsd-kind-module">
558
- <a href="../modules/_lib_interfaces_statsoptions_.html">&quot;lib/interfaces/<wbr>Stats<wbr>Options&quot;</a>
559
- </li>
560
- <li class=" tsd-kind-module">
561
- <a href="../modules/_lib_interfaces_supressions_.html">&quot;lib/interfaces/<wbr>Supressions&quot;</a>
562
- </li>
563
- <li class=" tsd-kind-module">
564
- <a href="../modules/_lib_messages_.html">&quot;lib/messages&quot;</a>
565
- </li>
566
- <li class=" tsd-kind-module">
567
- <a href="../modules/_lib_parse_.html">&quot;lib/parse&quot;</a>
568
- </li>
569
- <li class="current tsd-kind-module">
570
- <a href="../modules/_lib_request_.html">&quot;lib/request&quot;</a>
571
- </li>
572
- <li class=" tsd-kind-module">
573
- <a href="../modules/_lib_routes_.html">&quot;lib/routes&quot;</a>
574
- </li>
575
- <li class=" tsd-kind-module">
576
- <a href="../modules/_lib_stats_.html">&quot;lib/stats&quot;</a>
577
- </li>
578
- <li class=" tsd-kind-module">
579
- <a href="../modules/_lib_suppressions_.html">&quot;lib/suppressions&quot;</a>
580
- </li>
581
- <li class=" tsd-kind-module">
582
- <a href="../modules/_lib_validate_.html">&quot;lib/validate&quot;</a>
583
- </li>
584
- <li class=" tsd-kind-module">
585
- <a href="../modules/_lib_webhooks_.html">&quot;lib/webhooks&quot;</a>
586
- </li>
587
- <li class=" tsd-kind-module">
588
- <a href="../modules/_webpack_config_.html">&quot;webpack.config&quot;</a>
589
- </li>
590
- <li class=" tsd-kind-module">
591
- <a href="../modules/_webpack_release_config_.html">&quot;webpack.release.config&quot;</a>
592
- </li>
593
- </ul>
594
- </nav>
595
- <nav class="tsd-navigation secondary menu-sticky">
596
- <ul class="before-current">
597
- </ul>
598
- <ul class="current">
599
- <li class="current tsd-kind-class tsd-parent-kind-module">
600
- <a href="_lib_request_.request.html" class="tsd-kind-icon">Request</a>
601
- <ul>
602
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
603
- <a href="_lib_request_.request.html#constructor" class="tsd-kind-icon">constructor</a>
604
- </li>
605
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
606
- <a href="_lib_request_.request.html#formdata" class="tsd-kind-icon">form<wbr>Data</a>
607
- </li>
608
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
609
- <a href="_lib_request_.request.html#headers" class="tsd-kind-icon">headers</a>
610
- </li>
611
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
612
- <a href="_lib_request_.request.html#key" class="tsd-kind-icon">key</a>
613
- </li>
614
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
615
- <a href="_lib_request_.request.html#url" class="tsd-kind-icon">url</a>
616
- </li>
617
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
618
- <a href="_lib_request_.request.html#username" class="tsd-kind-icon">username</a>
619
- </li>
620
- <li class=" tsd-kind-method tsd-parent-kind-class">
621
- <a href="_lib_request_.request.html#command" class="tsd-kind-icon">command</a>
622
- </li>
623
- <li class=" tsd-kind-method tsd-parent-kind-class">
624
- <a href="_lib_request_.request.html#delete" class="tsd-kind-icon">delete</a>
625
- </li>
626
- <li class=" tsd-kind-method tsd-parent-kind-class">
627
- <a href="_lib_request_.request.html#get" class="tsd-kind-icon">get</a>
628
- </li>
629
- <li class=" tsd-kind-method tsd-parent-kind-class">
630
- <a href="_lib_request_.request.html#head" class="tsd-kind-icon">head</a>
631
- </li>
632
- <li class=" tsd-kind-method tsd-parent-kind-class">
633
- <a href="_lib_request_.request.html#options" class="tsd-kind-icon">options</a>
634
- </li>
635
- <li class=" tsd-kind-method tsd-parent-kind-class">
636
- <a href="_lib_request_.request.html#patch" class="tsd-kind-icon">patch</a>
637
- </li>
638
- <li class=" tsd-kind-method tsd-parent-kind-class">
639
- <a href="_lib_request_.request.html#post" class="tsd-kind-icon">post</a>
640
- </li>
641
- <li class=" tsd-kind-method tsd-parent-kind-class">
642
- <a href="_lib_request_.request.html#postmulti" class="tsd-kind-icon">post<wbr>Multi</a>
643
- </li>
644
- <li class=" tsd-kind-method tsd-parent-kind-class">
645
- <a href="_lib_request_.request.html#put" class="tsd-kind-icon">put</a>
646
- </li>
647
- <li class=" tsd-kind-method tsd-parent-kind-class">
648
- <a href="_lib_request_.request.html#query" class="tsd-kind-icon">query</a>
649
- </li>
650
- <li class=" tsd-kind-method tsd-parent-kind-class">
651
- <a href="_lib_request_.request.html#request" class="tsd-kind-icon">request</a>
652
- </li>
653
- </ul>
654
- </li>
655
- </ul>
656
- <ul class="after-current">
657
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
658
- <a href="../modules/_lib_request_.html#getattachmentoptions" class="tsd-kind-icon">get<wbr>Attachment<wbr>Options</a>
659
- </li>
660
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
661
- <a href="../modules/_lib_request_.html#isstream" class="tsd-kind-icon">is<wbr>Stream</a>
662
- </li>
663
- </ul>
664
- </nav>
665
- </div>
666
- </div>
667
- </div>
668
- <footer class="with-border-bottom">
669
- <div class="container">
670
- <h2>Legend</h2>
671
- <div class="tsd-legend-group">
672
- <ul class="tsd-legend">
673
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
674
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
675
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
676
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
677
- </ul>
678
- <ul class="tsd-legend">
679
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
680
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
681
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
682
- </ul>
683
- <ul class="tsd-legend">
684
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
685
- </ul>
686
- <ul class="tsd-legend">
687
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
688
- </ul>
689
- </div>
690
- </div>
691
- </footer>
692
- <div class="container tsd-generator">
693
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
694
- </div>
695
- <div class="overlay"></div>
696
- <script src="../assets/js/main.js"></script>
697
- </body>
698
- </html>