@coveo/push-api-client 2.4.17 → 2.4.27

package/dist/docs/classes/errors.PrivilegeError.html

@@ -19,7 +19,9 @@
 <ul class="tsd-hierarchy">
 <li><span class="tsd-signature-type">PushApiClientBaseError</span>
 <ul class="tsd-hierarchy">
-<li><span class="target">PrivilegeError</span></li></ul></li></ul></section>
+<li><span class="target">PrivilegeError</span></li></ul></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/privilegeError.ts#L3">src/errors/privilegeError.ts:3</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -46,8 +48,7 @@
 <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"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
-<li class="tsd-signature" id="constructor.new_PrivilegeError">new <wbr/>Privilege<wbr/>Error<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><a href="errors.PrivilegeError.html" class="tsd-signature-type" data-tsd-kind="Class">PrivilegeError</a></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="constructor.new_PrivilegeError">new <wbr/>Privilege<wbr/>Error<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><a href="errors.PrivilegeError.html" class="tsd-signature-type" data-tsd-kind="Class">PrivilegeError</a><a href="#constructor.new_PrivilegeError" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -55,7 +56,9 @@
 <li>
 <h5>message: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="errors.PrivilegeError.html" class="tsd-signature-type" data-tsd-kind="Class">PrivilegeError</a></h4><aside class="tsd-sources">
-<p>Overrides PushApiClientBaseError.constructor</p></aside></li></ul></section></section>
+<p>Overrides PushApiClientBaseError.constructor</p>
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></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 tsd-is-inherited"><a id="message" class="tsd-anchor"></a>
@@ -63,13 +66,13 @@
 <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Inherited from PushApiClientBaseError.message</p>
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Privilege Error&#39;</span></div><aside class="tsd-sources">
 <p>Overrides PushApiClientBaseError.name</p>
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -84,8 +87,7 @@
 <ul class="tsd-parameters">
 <li class="tsd-parameter-signature">
 <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
-<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p>
 
@@ -113,8 +115,7 @@
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
-<li class="tsd-signature" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p>
 </div>
@@ -126,7 +127,9 @@
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
-<p>Inherited from PushApiClientBaseError.captureStackTrace</p></aside></li></ul></section></section></div>
+<p>Inherited from PushApiClientBaseError.captureStackTrace</p>
+<ul>
+<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

package/dist/docs/classes/errors.UnsupportedAttribute.html

@@ -19,7 +19,9 @@
 <ul class="tsd-hierarchy">
 <li><span class="tsd-signature-type">PushApiClientBaseError</span>
 <ul class="tsd-hierarchy">
-<li><span class="target">UnsupportedAttribute</span></li></ul></li></ul></section>
+<li><span class="target">UnsupportedAttribute</span></li></ul></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/validatorErrors.ts#L24">src/errors/validatorErrors.ts:24</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -46,8 +48,7 @@
 <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"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
-<li class="tsd-signature" id="constructor.new_UnsupportedAttribute">new <wbr/>Unsupported<wbr/>Attribute<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, unsupported<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><a href="errors.UnsupportedAttribute.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedAttribute</a></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="constructor.new_UnsupportedAttribute">new <wbr/>Unsupported<wbr/>Attribute<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, unsupported<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><a href="errors.UnsupportedAttribute.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedAttribute</a><a href="#constructor.new_UnsupportedAttribute" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -57,7 +58,9 @@
 <li>
 <h5>unsupported: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="errors.UnsupportedAttribute.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedAttribute</a></h4><aside class="tsd-sources">
-<p>Overrides PushApiClientBaseError.constructor</p></aside></li></ul></section></section>
+<p>Overrides PushApiClientBaseError.constructor</p>
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/validatorErrors.ts#L26">src/errors/validatorErrors.ts:26</a></li></ul></aside></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 tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -71,7 +74,7 @@
 <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Unsupported Attribute Error&#39;</span></div><aside class="tsd-sources">
 <p>Overrides PushApiClientBaseError.name</p>
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/errors/validatorErrors.ts#L25">src/errors/validatorErrors.ts:25</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/validatorErrors.ts#L25">src/errors/validatorErrors.ts:25</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -86,8 +89,7 @@
 <ul class="tsd-parameters">
 <li class="tsd-parameter-signature">
 <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
-<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p>
 
@@ -115,8 +117,7 @@
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
-<li class="tsd-signature" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p>
 </div>
@@ -128,7 +129,9 @@
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
-<p>Inherited from PushApiClientBaseError.captureStackTrace</p></aside></li></ul></section></section></div>
+<p>Inherited from PushApiClientBaseError.captureStackTrace</p>
+<ul>
+<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

package/dist/docs/classes/errors.UnsupportedFieldError.html

@@ -19,7 +19,9 @@
 <ul class="tsd-hierarchy">
 <li><span class="tsd-signature-type">PushApiClientBaseError</span>
 <ul class="tsd-hierarchy">
-<li><span class="target">UnsupportedFieldError</span></li></ul></li></ul></section>
+<li><span class="target">UnsupportedFieldError</span></li></ul></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -41,7 +43,7 @@
 </div></section>
 <section class="tsd-index-section">
 <h3 class="tsd-index-heading">Accessors</h3>
-<div class="tsd-index-list"><a href="errors.UnsupportedFieldError.html#formattedFieldList" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>formatted<wbr/>Field<wbr/>List</span></a>
+<div class="tsd-index-list"><a href="errors.UnsupportedFieldError.html#formattedFieldList" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>formatted<wbr/>Field<wbr/>List</span></a>
 </div></section>
 <section class="tsd-index-section">
 <h3 class="tsd-index-heading">Methods</h3>
@@ -52,8 +54,7 @@
 <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"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
-<li class="tsd-signature" id="constructor.new_UnsupportedFieldError">new <wbr/>Unsupported<wbr/>Field<wbr/>Error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>unsupportedFields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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><a href="errors.UnsupportedFieldError.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedFieldError</a></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="constructor.new_UnsupportedFieldError">new <wbr/>Unsupported<wbr/>Field<wbr/>Error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>unsupportedFields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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><a href="errors.UnsupportedFieldError.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedFieldError</a><a href="#constructor.new_UnsupportedFieldError" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -61,7 +62,9 @@
 <li>
 <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>unsupportedFields: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="errors.UnsupportedFieldError.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedFieldError</a></h4><aside class="tsd-sources">
-<p>Overrides PushApiClientBaseError.constructor</p></aside></li></ul></section></section>
+<p>Overrides PushApiClientBaseError.constructor</p>
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></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 tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -75,7 +78,7 @@
 <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Unsupported field Error&#39;</span></div><aside class="tsd-sources">
 <p>Overrides PushApiClientBaseError.name</p>
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -86,12 +89,12 @@
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>unsupported<wbr/>Fields</span><a href="#unsupportedFields" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">unsupported<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyFieldNameReplacer" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>empty<wbr/>Field<wbr/>Name<wbr/>Replacer</span><a href="#emptyFieldNameReplacer" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">empty<wbr/>Field<wbr/>Name<wbr/>Replacer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&lt;empty field name&gt;&#39;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -100,8 +103,7 @@
 <ul class="tsd-parameters">
 <li class="tsd-parameter-signature">
 <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
-<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p>
 
@@ -126,20 +128,20 @@
 <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Accessors</h2>
-<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="formattedFieldList" class="tsd-anchor"></a>
+<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="formattedFieldList" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>formatted<wbr/>Field<wbr/>List</span><a href="#formattedFieldList" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
-<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
-<li class="tsd-signature" id="formattedFieldList.formattedFieldList-1"><span class="tsd-signature-symbol">get</span> formattedFieldList<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul>
-<ul class="tsd-descriptions">
+<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-private">
+<li class="tsd-signature" id="formattedFieldList.formattedFieldList-1"><span class="tsd-signature-symbol">get</span> formattedFieldList<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
 <li class="tsd-description">
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></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 tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
-<li class="tsd-signature" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p>
 </div>
@@ -151,7 +153,9 @@
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
-<p>Inherited from PushApiClientBaseError.captureStackTrace</p></aside></li></ul></section></section></div>
+<p>Inherited from PushApiClientBaseError.captureStackTrace</p>
+<ul>
+<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -186,7 +190,7 @@
 <li class="tsd-kind-property tsd-parent-kind-class"><a href="errors.UnsupportedFieldError.html#emptyFieldNameReplacer" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>empty<wbr/>Field<wbr/>Name<wbr/>Replacer</a></li>
 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.UnsupportedFieldError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.UnsupportedFieldError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
-<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="errors.UnsupportedFieldError.html#formattedFieldList" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>formatted<wbr/>Field<wbr/>List</a></li>
+<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a href="errors.UnsupportedFieldError.html#formattedFieldList" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>formatted<wbr/>Field<wbr/>List</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.UnsupportedFieldError.html#captureStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div>
 <div class="container tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>

package/dist/docs/enums/PlatformEnvironment.html

@@ -12,7 +12,9 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">@coveo/push-api-client</a></li>
 <li><a href="PlatformEnvironment.html">PlatformEnvironment</a></li></ul>
-<h1>Enumeration PlatformEnvironment</h1></div>
+<h1>Enumeration PlatformEnvironment</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -31,22 +33,22 @@
 <h3 class="tsd-anchor-link"><span>Dev</span><a href="#Dev" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">Dev<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dev&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Hipaa" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Hipaa</span><a href="#Hipaa" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Hipaa<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;hipaa&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Prod" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Prod</span><a href="#Prod" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Prod<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;prod&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stg" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Stg</span><a href="#Stg" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Stg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stg&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

package/dist/docs/enums/Region.html

@@ -12,7 +12,9 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">@coveo/push-api-client</a></li>
 <li><a href="Region.html">Region</a></li></ul>
-<h1>Enumeration Region</h1></div>
+<h1>Enumeration Region</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in node_modules/@coveord/platform-client/dist/definitions/Endpoints.d.ts:1</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">

package/dist/docs/enums/SourceVisibility.html

@@ -12,7 +12,9 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">@coveo/push-api-client</a></li>
 <li><a href="SourceVisibility.html">SourceVisibility</a></li></ul>
-<h1>Enumeration SourceVisibility</h1></div>
+<h1>Enumeration SourceVisibility</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:144</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">

package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html

@@ -15,8 +15,7 @@
 <h1>Function parseAndGetDocumentBuilderFromJSONDocument</h1></div>
 <section class="tsd-panel">
 <ul class="tsd-signatures tsd-kind-function">
-<li class="tsd-signature" id="parseAndGetDocumentBuilderFromJSONDocument">parse<wbr/>And<wbr/>Get<wbr/>Document<wbr/>Builder<wbr/>FromJSONDocument<span class="tsd-signature-symbol">(</span>documentPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParseDocumentOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature tsd-anchor-link" id="parseAndGetDocumentBuilderFromJSONDocument">parse<wbr/>And<wbr/>Get<wbr/>Document<wbr/>Builder<wbr/>FromJSONDocument<span class="tsd-signature-symbol">(</span>documentPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParseDocumentOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><a href="#parseAndGetDocumentBuilderFromJSONDocument" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -25,7 +24,9 @@
 <h5>documentPath: <span class="tsd-signature-type">PathLike</span></h5></li>
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
+<h4 class="tsd-returns-title">Returns <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

package/dist/docs/index.html

@@ -11,9 +11,56 @@
 <div class="tsd-page-title">
 <h2>@coveo/push-api-client</h2></div>
 <div class="tsd-panel tsd-typography">
-<a href="#" id="" style="color: inherit; text-decoration: none;">
-  <h1></h1>
+<a href="#coveopush-api-clientjs" id="coveopush-api-clientjs" style="color: inherit; text-decoration: none;">
+  <h1>@coveo/push-api-client.js</h1>
 </a>
+<p>Coveo Push API client</p>
+
+<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
+  <h2>Installation</h2>
+</a>
+<p><code>npm i @coveo/push-api-client</code></p>
+
+<a href="#features" id="features" style="color: inherit; text-decoration: none;">
+  <h2>Features</h2>
+</a>
+<ul>
+<li>Upload data to both Push and Catalog sources</li>
+<li>Pre-push document validation</li>
+<li>Automatic custom field creation</li>
+<li>Full catalog upload and incremental document update</li>
+<li>Optimized for large payload uploads</li>
+</ul>
+
+<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
+  <h2>Usage</h2>
+</a>
+<pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> {</span><span class="hl-2">PushSource</span><span class="hl-1">, </span><span class="hl-2">DocumentBuilder</span><span class="hl-1">} </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@coveo/push-api-client&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">PushSource</span><span class="hl-1">(</span><span class="hl-3">&#39;my_api_key&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;my_coveo_organization_id&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">myDocument</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">DocumentBuilder</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-3">&#39;https://my.document.uri&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-3">&#39;My document title&#39;</span><br/><span class="hl-1">  ).</span><span class="hl-5">withData</span><span class="hl-1">(</span><span class="hl-3">&#39;these words will be searchable&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">  </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">source</span><span class="hl-1">.</span><span class="hl-5">addOrUpdateDocument</span><span class="hl-1">(</span><span class="hl-3">&#39;my_source_id&#39;</span><span class="hl-1">, </span><span class="hl-2">myDocument</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">main</span><span class="hl-1">();</span>
+</code></pre>
+<p>You can also upload your data into a catalog source</p>
+<pre><code class="language-js"><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">CatalogSource</span><span class="hl-1">(</span><span class="hl-3">&#39;my_api_key&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;my_coveo_organization_id&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">  </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">source</span><br/><span class="hl-1">    .</span><span class="hl-5">batchStreamDocumentsFromFiles</span><span class="hl-1">(</span><span class="hl-3">&#39;my_source_id&#39;</span><span class="hl-1">, [</span><span class="hl-3">&#39;path/to/file_or_folder&#39;</span><span class="hl-1">])</span><br/><span class="hl-1">    .</span><span class="hl-5">batch</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">main</span><span class="hl-1">();</span><br/>
+</code></pre>
+<p>See more examples in the <code>./samples</code> folder.</p>
+
+<a href="#local-development" id="local-development" style="color: inherit; text-decoration: none;">
+  <h2>Local development</h2>
+</a>
+<ul>
+<li><code>npm i</code></li>
+<li>Copy <code>env.sample</code> to <code>.env</code>, and replace the variables with proper values.</li>
+<li><code>npm run dev</code> to compile and run <code>./src/localtest.ts</code>.</li>
+<li><code>npm run test</code> for unit tests.</li>
+</ul>
+
+<a href="#commit" id="commit" style="color: inherit; text-decoration: none;">
+  <h2>Commit</h2>
+</a>
+<p>Use <code>npm run commit</code> to get a properly formatted commit message which will help control the versioning and CHANGELOG generation.</p>
+
+<a href="#release" id="release" style="color: inherit; text-decoration: none;">
+  <h2>Release</h2>
+</a>
+<p>Run Github action named <code>release</code>, which will bump version, tag and publish to npm.</p>
 </div></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">

package/dist/docs/interfaces/BatchUpdateDocuments.html

@@ -16,7 +16,9 @@
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
-<li><span class="target">BatchUpdateDocuments</span></li></ul></section>
+<li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,12 +35,12 @@
 <h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update</span><a href="#addOrUpdate" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">add<wbr/>Or<wbr/>Update<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<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></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cc51cb8/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">