npm - mailgun.js - Versions diffs - 4.1.4 → 4.2.1 - Mend

mailgun.js 4.1.4 → 4.2.1

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 (264) hide show

package/docs/classes/validate.default.html ADDED Viewed

@@ -0,0 +1 @@

package/docs/classes/webhooks.default.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | mailgun.js</title><meta name="description" content="Documentation for mailgun.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mailgun.js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mailgun.js</a></li><li><a href="../modules/webhooks.html">webhooks</a></li><li><a href="webhooks.default.html">default</a></li></ul><h1>Class default</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="webhooks.default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="webhooks.default.html#request" class="tsd-kind-icon">request</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#_parseWebhookList" class="tsd-kind-icon">_parse<wbr/>Webhook<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#_parseWebhookTest" class="tsd-kind-icon">_parse<wbr/>Webhook<wbr/>Test</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#_parseWebhookWithID" class="tsd-kind-icon">_parse<wbr/>Webhook<wbr/>WithID</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#update" class="tsd-kind-icon">update</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="request.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="webhooks.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L24">lib/webhooks.ts:24</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>request: <a href="request.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="webhooks.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link">request<a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="request.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L22">lib/webhooks.ts:22</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_parseWebhookList" class="tsd-anchor"></a><h3 class="tsd-anchor-link">_parse<wbr/>Webhook<wbr/>List<a href="#_parseWebhookList" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_parse<wbr/>Webhook<wbr/>List<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>webhooks<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L28">lib/webhooks.ts:28</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>webhooks<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>webhooks<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>webhooks<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a></h5></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_parseWebhookTest" class="tsd-anchor"></a><h3 class="tsd-anchor-link">_parse<wbr/>Webhook<wbr/>Test<a href="#_parseWebhookTest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_parse<wbr/>Webhook<wbr/>Test<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>message<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L43">lib/webhooks.ts:43</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>response: <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>message<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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_parseWebhookWithID" class="tsd-anchor"></a><h3 class="tsd-anchor-link">_parse<wbr/>Webhook<wbr/>WithID<a href="#_parseWebhookWithID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_parse<wbr/>Webhook<wbr/>WithID<span class="tsd-signature-symbol">(</span>id<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>response<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Webhook</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L32">lib/webhooks.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Webhook</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhookResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Webhook</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>response: <a href="../interfaces/interfaces_Webhooks.WebhookResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookResponse</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Webhook</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<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>, test<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/interfaces_Webhooks.ValidationResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationResponse</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L58">lib/webhooks.ts:58</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5></li><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>url: <span class="tsd-signature-type">string</span></h5></li><li><h5>test: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/interfaces_Webhooks.ValidationResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationResponse</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L76">lib/webhooks.ts:76</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5></li><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L53">lib/webhooks.ts:53</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5></li><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces_Webhooks.WebhooksQuery.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhooksQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L48">lib/webhooks.ts:48</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5></li><li><h5>query: <a href="../interfaces/interfaces_Webhooks.WebhooksQuery.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhooksQuery</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/interfaces_Webhooks.WebhookList.html" class="tsd-signature-type" data-tsd-kind="Interface">WebhookList</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="update" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/webhooks.ts#L71">lib/webhooks.ts:71</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5></li><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Webhook</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/client.html">client</a></li><li class=" tsd-kind-module"><a href="../modules/domains.html">domains</a></li><li class=" tsd-kind-module"><a href="../modules/domainsCredentials.html">domains<wbr/>Credentials</a></li><li class=" tsd-kind-module"><a href="../modules/domainsTemplates.html">domains<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="../modules/error.html">error</a></li><li class=" tsd-kind-module"><a href="../modules/events.html">events</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_APIErrorOptions.html">interfaces/APIError<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_ApiResponse.html">interfaces/<wbr/>Api<wbr/>Response</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainCredentials.html">interfaces/<wbr/>Domain<wbr/>Credentials</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainTemplates.html">interfaces/<wbr/>Domain<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainTracking.html">interfaces/<wbr/>Domain<wbr/>Tracking</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Domains.html">interfaces/<wbr/>Domains</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Events.html">interfaces/<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_IFormData.html">interfaces/IForm<wbr/>Data</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_IpPools.html">interfaces/<wbr/>Ip<wbr/>Pools</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Ips.html">interfaces/<wbr/>Ips</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_MultipleValidation.html">interfaces/<wbr/>Multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Options.html">interfaces/<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_RequestOptions.html">interfaces/<wbr/>Request<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_StatsOptions.html">interfaces/<wbr/>Stats<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Supressions.html">interfaces/<wbr/>Supressions</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Validate.html">interfaces/<wbr/>Validate</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Webhooks.html">interfaces/<wbr/>Webhooks</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_lists.html">interfaces/lists</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_mailListMembers.html">interfaces/mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_routes.html">interfaces/routes</a></li><li class=" tsd-kind-module"><a href="../modules/ip_pools.html">ip-<wbr/>pools</a></li><li class=" tsd-kind-module"><a href="../modules/ips.html">ips</a></li><li class=" tsd-kind-module"><a href="../modules/lists.html">lists</a></li><li class=" tsd-kind-module"><a href="../modules/mailListMembers.html">mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="../modules/messages.html">messages</a></li><li class=" tsd-kind-module"><a href="../modules/multipleValidation.html">multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="../modules/request.html">request</a></li><li class=" tsd-kind-module"><a href="../modules/routes.html">routes</a></li><li class=" tsd-kind-module"><a href="../modules/stats.html">stats</a></li><li class=" tsd-kind-module"><a href="../modules/suppressions.html">suppressions</a></li><li class=" tsd-kind-module"><a href="../modules/validate.html">validate</a></li><li class="current tsd-kind-module"><a href="../modules/webhooks.html">webhooks</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="webhooks.default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="webhooks.default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="webhooks.default.html#request" class="tsd-kind-icon">request</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#_parseWebhookList" class="tsd-kind-icon">_parse<wbr/>Webhook<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#_parseWebhookTest" class="tsd-kind-icon">_parse<wbr/>Webhook<wbr/>Test</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#_parseWebhookWithID" class="tsd-kind-icon">_parse<wbr/>Webhook<wbr/>WithID</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="webhooks.default.html#update" class="tsd-kind-icon">update</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/docs/enums/interfaces_DomainTemplates.Pages.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Pages | mailgun.js</title><meta name="description" content="Documentation for mailgun.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mailgun.js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mailgun.js</a></li><li><a href="../modules/interfaces_DomainTemplates.html">interfaces/DomainTemplates</a></li><li><a href="interfaces_DomainTemplates.Pages.html">Pages</a></li></ul><h1>Enumeration Pages</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#FIRST" class="tsd-kind-icon">FIRST</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#LAST" class="tsd-kind-icon">LAST</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#NEXT" class="tsd-kind-icon">NEXT</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#PREV" class="tsd-kind-icon">PREV</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FIRST" class="tsd-anchor"></a><h3 class="tsd-anchor-link">FIRST<a href="#FIRST" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FIRST<span class="tsd-signature-symbol"> = "first"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/interfaces/DomainTemplates.ts#L9">lib/interfaces/DomainTemplates.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LAST" class="tsd-anchor"></a><h3 class="tsd-anchor-link">LAST<a href="#LAST" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">LAST<span class="tsd-signature-symbol"> = "last"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/interfaces/DomainTemplates.ts#L10">lib/interfaces/DomainTemplates.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NEXT" class="tsd-anchor"></a><h3 class="tsd-anchor-link">NEXT<a href="#NEXT" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">NEXT<span class="tsd-signature-symbol"> = "next"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/interfaces/DomainTemplates.ts#L11">lib/interfaces/DomainTemplates.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="PREV" class="tsd-anchor"></a><h3 class="tsd-anchor-link">PREV<a href="#PREV" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">PREV<span class="tsd-signature-symbol"> = "prev"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/interfaces/DomainTemplates.ts#L12">lib/interfaces/DomainTemplates.ts:12</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/client.html">client</a></li><li class=" tsd-kind-module"><a href="../modules/domains.html">domains</a></li><li class=" tsd-kind-module"><a href="../modules/domainsCredentials.html">domains<wbr/>Credentials</a></li><li class=" tsd-kind-module"><a href="../modules/domainsTemplates.html">domains<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="../modules/error.html">error</a></li><li class=" tsd-kind-module"><a href="../modules/events.html">events</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_APIErrorOptions.html">interfaces/APIError<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_ApiResponse.html">interfaces/<wbr/>Api<wbr/>Response</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainCredentials.html">interfaces/<wbr/>Domain<wbr/>Credentials</a></li><li class="current tsd-kind-module"><a href="../modules/interfaces_DomainTemplates.html">interfaces/<wbr/>Domain<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainTracking.html">interfaces/<wbr/>Domain<wbr/>Tracking</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Domains.html">interfaces/<wbr/>Domains</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Events.html">interfaces/<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_IFormData.html">interfaces/IForm<wbr/>Data</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_IpPools.html">interfaces/<wbr/>Ip<wbr/>Pools</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Ips.html">interfaces/<wbr/>Ips</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_MultipleValidation.html">interfaces/<wbr/>Multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Options.html">interfaces/<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_RequestOptions.html">interfaces/<wbr/>Request<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_StatsOptions.html">interfaces/<wbr/>Stats<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Supressions.html">interfaces/<wbr/>Supressions</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Validate.html">interfaces/<wbr/>Validate</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Webhooks.html">interfaces/<wbr/>Webhooks</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_lists.html">interfaces/lists</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_mailListMembers.html">interfaces/mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_routes.html">interfaces/routes</a></li><li class=" tsd-kind-module"><a href="../modules/ip_pools.html">ip-<wbr/>pools</a></li><li class=" tsd-kind-module"><a href="../modules/ips.html">ips</a></li><li class=" tsd-kind-module"><a href="../modules/lists.html">lists</a></li><li class=" tsd-kind-module"><a href="../modules/mailListMembers.html">mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="../modules/messages.html">messages</a></li><li class=" tsd-kind-module"><a href="../modules/multipleValidation.html">multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="../modules/request.html">request</a></li><li class=" tsd-kind-module"><a href="../modules/routes.html">routes</a></li><li class=" tsd-kind-module"><a href="../modules/stats.html">stats</a></li><li class=" tsd-kind-module"><a href="../modules/suppressions.html">suppressions</a></li><li class=" tsd-kind-module"><a href="../modules/validate.html">validate</a></li><li class=" tsd-kind-module"><a href="../modules/webhooks.html">webhooks</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-module"><a href="interfaces_DomainTemplates.Pages.html" class="tsd-kind-icon">Pages</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#FIRST" class="tsd-kind-icon">FIRST</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#LAST" class="tsd-kind-icon">LAST</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#NEXT" class="tsd-kind-icon">NEXT</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.Pages.html#PREV" class="tsd-kind-icon">PREV</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/docs/enums/interfaces_DomainTemplates.YesNo.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>YesNo | mailgun.js</title><meta name="description" content="Documentation for mailgun.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mailgun.js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mailgun.js</a></li><li><a href="../modules/interfaces_DomainTemplates.html">interfaces/DomainTemplates</a></li><li><a href="interfaces_DomainTemplates.YesNo.html">YesNo</a></li></ul><h1>Enumeration YesNo</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.YesNo.html#NO" class="tsd-kind-icon">NO</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.YesNo.html#YES" class="tsd-kind-icon">YES</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NO" class="tsd-anchor"></a><h3 class="tsd-anchor-link">NO<a href="#NO" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">NO<span class="tsd-signature-symbol"> = "no"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/interfaces/DomainTemplates.ts#L5">lib/interfaces/DomainTemplates.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="YES" class="tsd-anchor"></a><h3 class="tsd-anchor-link">YES<a href="#YES" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">YES<span class="tsd-signature-symbol"> = "yes"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mailgun/mailgun.js/blob/baf59b7/lib/interfaces/DomainTemplates.ts#L4">lib/interfaces/DomainTemplates.ts:4</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/client.html">client</a></li><li class=" tsd-kind-module"><a href="../modules/domains.html">domains</a></li><li class=" tsd-kind-module"><a href="../modules/domainsCredentials.html">domains<wbr/>Credentials</a></li><li class=" tsd-kind-module"><a href="../modules/domainsTemplates.html">domains<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="../modules/error.html">error</a></li><li class=" tsd-kind-module"><a href="../modules/events.html">events</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_APIErrorOptions.html">interfaces/APIError<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_ApiResponse.html">interfaces/<wbr/>Api<wbr/>Response</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainCredentials.html">interfaces/<wbr/>Domain<wbr/>Credentials</a></li><li class="current tsd-kind-module"><a href="../modules/interfaces_DomainTemplates.html">interfaces/<wbr/>Domain<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_DomainTracking.html">interfaces/<wbr/>Domain<wbr/>Tracking</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Domains.html">interfaces/<wbr/>Domains</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Events.html">interfaces/<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_IFormData.html">interfaces/IForm<wbr/>Data</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_IpPools.html">interfaces/<wbr/>Ip<wbr/>Pools</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Ips.html">interfaces/<wbr/>Ips</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_MultipleValidation.html">interfaces/<wbr/>Multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Options.html">interfaces/<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_RequestOptions.html">interfaces/<wbr/>Request<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_StatsOptions.html">interfaces/<wbr/>Stats<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Supressions.html">interfaces/<wbr/>Supressions</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Validate.html">interfaces/<wbr/>Validate</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_Webhooks.html">interfaces/<wbr/>Webhooks</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_lists.html">interfaces/lists</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_mailListMembers.html">interfaces/mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="../modules/interfaces_routes.html">interfaces/routes</a></li><li class=" tsd-kind-module"><a href="../modules/ip_pools.html">ip-<wbr/>pools</a></li><li class=" tsd-kind-module"><a href="../modules/ips.html">ips</a></li><li class=" tsd-kind-module"><a href="../modules/lists.html">lists</a></li><li class=" tsd-kind-module"><a href="../modules/mailListMembers.html">mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="../modules/messages.html">messages</a></li><li class=" tsd-kind-module"><a href="../modules/multipleValidation.html">multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="../modules/request.html">request</a></li><li class=" tsd-kind-module"><a href="../modules/routes.html">routes</a></li><li class=" tsd-kind-module"><a href="../modules/stats.html">stats</a></li><li class=" tsd-kind-module"><a href="../modules/suppressions.html">suppressions</a></li><li class=" tsd-kind-module"><a href="../modules/validate.html">validate</a></li><li class=" tsd-kind-module"><a href="../modules/webhooks.html">webhooks</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-module"><a href="interfaces_DomainTemplates.YesNo.html" class="tsd-kind-icon">Yes<wbr/>No</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.YesNo.html#NO" class="tsd-kind-icon">NO</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="interfaces_DomainTemplates.YesNo.html#YES" class="tsd-kind-icon">YES</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>