@coveo/push-api-client 2.7.2 → 2.7.4

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 (44) hide show
  1. package/dist/definitions/document.d.ts +6 -6
  2. package/dist/definitions/environment.d.ts +1 -1
  3. package/dist/definitions/fieldAnalyser/fieldAnalyser.d.ts +1 -1
  4. package/dist/definitions/help/fileConsumer.d.ts +2 -2
  5. package/dist/definitions/help/generator.d.ts +1 -1
  6. package/dist/definitions/interfaces.d.ts +1 -1
  7. package/dist/definitions/source/push.d.ts +1 -1
  8. package/dist/definitions/validation/transformers/transformer.d.ts +1 -1
  9. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  10. package/dist/docs/classes/CatalogSource.html +17 -17
  11. package/dist/docs/classes/DocumentBuilder.html +28 -28
  12. package/dist/docs/classes/FieldAnalyser.html +12 -12
  13. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  14. package/dist/docs/classes/PushSource.html +24 -24
  15. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  16. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  17. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +8 -8
  18. package/dist/docs/classes/errors.InvalidDocument.html +8 -8
  19. package/dist/docs/classes/errors.InvalidPermanentId.html +8 -8
  20. package/dist/docs/classes/errors.NotAFileError.html +8 -8
  21. package/dist/docs/classes/errors.NotAJsonFileError.html +8 -8
  22. package/dist/docs/classes/errors.PrivilegeError.html +8 -8
  23. package/dist/docs/classes/errors.UnsupportedAttribute.html +8 -8
  24. package/dist/docs/classes/errors.UnsupportedFieldError.html +11 -11
  25. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  26. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  27. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  28. package/dist/docs/interfaces/Document.html +14 -14
  29. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  30. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  31. package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
  32. package/dist/docs/modules/errors.html +1 -1
  33. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  34. package/dist/docs/types/CompressionType.html +1 -1
  35. package/dist/docs/types/FailedUploadCallback.html +1 -1
  36. package/dist/docs/types/Metadata.html +1 -1
  37. package/dist/docs/types/MetadataValue.html +1 -1
  38. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  39. package/dist/docs/types/SecurityIdentityType.html +1 -1
  40. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  41. package/dist/docs/types/Transformer.html +1 -1
  42. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  43. package/dist/docs/variables/Source.html +1 -1
  44. package/package.json +7 -7
package/dist/docs/classes/errors.InvalidPermanentId.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">InvalidPermanentId</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L27">src/errors/fieldErrors.ts:27</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L27">src/errors/fieldErrors.ts:27</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -60,7 +60,7 @@
60
60
  <h4 class="tsd-returns-title">Returns <a href="errors.InvalidPermanentId.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidPermanentId</a></h4><aside class="tsd-sources">
61
61
  <p>Overrides PushApiClientBaseError.constructor</p>
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L29">src/errors/fieldErrors.ts:29</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L29">src/errors/fieldErrors.ts:29</a></li></ul></aside></li></ul></section></section>
64
64
  <section class="tsd-panel-group tsd-member-group">
65
65
  <h2>Properties</h2>
66
66
  <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>
@@ -68,19 +68,19 @@
68
68
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
69
69
  <p>Inherited from PushApiClientBaseError.message</p>
70
70
  <ul>
71
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1041</li></ul></aside></section>
71
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
73
73
  <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>
74
74
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Invalid permanentId field Error&#39;</span></div><aside class="tsd-sources">
75
75
  <p>Overrides PushApiClientBaseError.name</p>
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
78
78
  <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>
79
79
  <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>
80
80
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
81
81
  <p>Inherited from PushApiClientBaseError.stack</p>
82
82
  <ul>
83
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
83
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
84
84
  <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>
85
85
  <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>
86
86
  <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>
@@ -105,13 +105,13 @@
105
105
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
106
106
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
107
107
  <ul>
108
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
108
+ <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
109
109
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
110
110
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
111
111
  <div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
112
112
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
113
113
  <ul>
114
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
114
+ <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
115
115
  <section class="tsd-panel-group tsd-member-group">
116
116
  <h2>Methods</h2>
117
117
  <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>
@@ -131,7 +131,7 @@
131
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
132
132
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
133
133
  <ul>
134
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
134
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
135
135
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
136
136
  <div class="tsd-navigation settings">
137
137
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.NotAFileError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">NotAFileError</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L4">src/errors/validatorErrors.ts:4</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L4">src/errors/validatorErrors.ts:4</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -60,7 +60,7 @@
60
60
  <h4 class="tsd-returns-title">Returns <a href="errors.NotAFileError.html" class="tsd-signature-type" data-tsd-kind="Class">NotAFileError</a></h4><aside class="tsd-sources">
61
61
  <p>Overrides PushApiClientBaseError.constructor</p>
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L6">src/errors/validatorErrors.ts:6</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L6">src/errors/validatorErrors.ts:6</a></li></ul></aside></li></ul></section></section>
64
64
  <section class="tsd-panel-group tsd-member-group">
65
65
  <h2>Properties</h2>
66
66
  <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>
@@ -68,19 +68,19 @@
68
68
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
69
69
  <p>Inherited from PushApiClientBaseError.message</p>
70
70
  <ul>
71
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1041</li></ul></aside></section>
71
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
73
73
  <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>
74
74
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Not A File Error&#39;</span></div><aside class="tsd-sources">
75
75
  <p>Overrides PushApiClientBaseError.name</p>
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</a></li></ul></aside></section>
78
78
  <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>
79
79
  <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>
80
80
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
81
81
  <p>Inherited from PushApiClientBaseError.stack</p>
82
82
  <ul>
83
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
83
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
84
84
  <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>
85
85
  <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>
86
86
  <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>
@@ -105,13 +105,13 @@
105
105
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
106
106
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
107
107
  <ul>
108
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
108
+ <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
109
109
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
110
110
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
111
111
  <div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
112
112
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
113
113
  <ul>
114
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
114
+ <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
115
115
  <section class="tsd-panel-group tsd-member-group">
116
116
  <h2>Methods</h2>
117
117
  <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>
@@ -131,7 +131,7 @@
131
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
132
132
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
133
133
  <ul>
134
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
134
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
135
135
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
136
136
  <div class="tsd-navigation settings">
137
137
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.NotAJsonFileError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">NotAJsonFileError</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L10">src/errors/validatorErrors.ts:10</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L10">src/errors/validatorErrors.ts:10</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -60,7 +60,7 @@
60
60
  <h4 class="tsd-returns-title">Returns <a href="errors.NotAJsonFileError.html" class="tsd-signature-type" data-tsd-kind="Class">NotAJsonFileError</a></h4><aside class="tsd-sources">
61
61
  <p>Overrides PushApiClientBaseError.constructor</p>
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L12">src/errors/validatorErrors.ts:12</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L12">src/errors/validatorErrors.ts:12</a></li></ul></aside></li></ul></section></section>
64
64
  <section class="tsd-panel-group tsd-member-group">
65
65
  <h2>Properties</h2>
66
66
  <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>
@@ -68,19 +68,19 @@
68
68
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
69
69
  <p>Inherited from PushApiClientBaseError.message</p>
70
70
  <ul>
71
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1041</li></ul></aside></section>
71
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
73
73
  <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>
74
74
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Not A JSON File Error&#39;</span></div><aside class="tsd-sources">
75
75
  <p>Overrides PushApiClientBaseError.name</p>
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</a></li></ul></aside></section>
78
78
  <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>
79
79
  <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>
80
80
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
81
81
  <p>Inherited from PushApiClientBaseError.stack</p>
82
82
  <ul>
83
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
83
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
84
84
  <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>
85
85
  <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>
86
86
  <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>
@@ -105,13 +105,13 @@
105
105
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
106
106
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
107
107
  <ul>
108
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
108
+ <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
109
109
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
110
110
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
111
111
  <div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
112
112
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
113
113
  <ul>
114
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
114
+ <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
115
115
  <section class="tsd-panel-group tsd-member-group">
116
116
  <h2>Methods</h2>
117
117
  <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>
@@ -131,7 +131,7 @@
131
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
132
132
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
133
133
  <ul>
134
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
134
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
135
135
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
136
136
  <div class="tsd-navigation settings">
137
137
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.PrivilegeError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">PrivilegeError</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/privilegeError.ts#L3">src/errors/privilegeError.ts:3</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/privilegeError.ts#L3">src/errors/privilegeError.ts:3</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -60,7 +60,7 @@
60
60
  <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">
61
61
  <p>Overrides PushApiClientBaseError.constructor</p>
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></li></ul></section></section>
64
64
  <section class="tsd-panel-group tsd-member-group">
65
65
  <h2>Properties</h2>
66
66
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a>
@@ -68,19 +68,19 @@
68
68
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
69
69
  <p>Inherited from PushApiClientBaseError.message</p>
70
70
  <ul>
71
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
71
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
73
73
  <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>
74
74
  <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">
75
75
  <p>Overrides PushApiClientBaseError.name</p>
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
78
78
  <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>
79
79
  <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>
80
80
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
81
81
  <p>Inherited from PushApiClientBaseError.stack</p>
82
82
  <ul>
83
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
83
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
84
84
  <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>
85
85
  <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>
86
86
  <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>
@@ -105,13 +105,13 @@
105
105
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
106
106
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
107
107
  <ul>
108
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
108
+ <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
109
109
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
110
110
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
111
111
  <div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
112
112
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
113
113
  <ul>
114
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
114
+ <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
115
115
  <section class="tsd-panel-group tsd-member-group">
116
116
  <h2>Methods</h2>
117
117
  <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>
@@ -131,7 +131,7 @@
131
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
132
132
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
133
133
  <ul>
134
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
134
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
135
135
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
136
136
  <div class="tsd-navigation settings">
137
137
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.UnsupportedAttribute.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">UnsupportedAttribute</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L31">src/errors/validatorErrors.ts:31</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L31">src/errors/validatorErrors.ts:31</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -62,7 +62,7 @@
62
62
  <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">
63
63
  <p>Overrides PushApiClientBaseError.constructor</p>
64
64
  <ul>
65
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L33">src/errors/validatorErrors.ts:33</a></li></ul></aside></li></ul></section></section>
65
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L33">src/errors/validatorErrors.ts:33</a></li></ul></aside></li></ul></section></section>
66
66
  <section class="tsd-panel-group tsd-member-group">
67
67
  <h2>Properties</h2>
68
68
  <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>
@@ -70,19 +70,19 @@
70
70
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
71
71
  <p>Inherited from PushApiClientBaseError.message</p>
72
72
  <ul>
73
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1041</li></ul></aside></section>
73
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
74
74
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
75
75
  <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>
76
76
  <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">
77
77
  <p>Overrides PushApiClientBaseError.name</p>
78
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/validatorErrors.ts#L32">src/errors/validatorErrors.ts:32</a></li></ul></aside></section>
79
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/validatorErrors.ts#L32">src/errors/validatorErrors.ts:32</a></li></ul></aside></section>
80
80
  <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>
81
81
  <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>
82
82
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
83
83
  <p>Inherited from PushApiClientBaseError.stack</p>
84
84
  <ul>
85
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
85
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
86
86
  <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>
87
87
  <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>
88
88
  <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>
@@ -107,13 +107,13 @@
107
107
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
108
108
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
109
109
  <ul>
110
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
110
+ <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
111
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
112
112
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
113
113
  <div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
114
114
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
115
115
  <ul>
116
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
116
+ <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
117
117
  <section class="tsd-panel-group tsd-member-group">
118
118
  <h2>Methods</h2>
119
119
  <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>
@@ -133,7 +133,7 @@
133
133
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
134
134
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
135
135
  <ul>
136
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
136
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
137
137
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
138
138
  <div class="tsd-navigation settings">
139
139
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.UnsupportedFieldError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">UnsupportedFieldError</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,7 +66,7 @@
66
66
  <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">
67
67
  <p>Overrides PushApiClientBaseError.constructor</p>
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
70
70
  <section class="tsd-panel-group tsd-member-group">
71
71
  <h2>Properties</h2>
72
72
  <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>
@@ -74,29 +74,29 @@
74
74
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
75
75
  <p>Inherited from PushApiClientBaseError.message</p>
76
76
  <ul>
77
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1041</li></ul></aside></section>
77
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
78
78
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
79
79
  <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>
80
80
  <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">
81
81
  <p>Overrides PushApiClientBaseError.name</p>
82
82
  <ul>
83
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
83
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
84
84
  <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>
85
85
  <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>
86
86
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
87
87
  <p>Inherited from PushApiClientBaseError.stack</p>
88
88
  <ul>
89
- <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1042</li></ul></aside></section>
89
+ <li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section>
90
90
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="unsupportedFields" class="tsd-anchor"></a>
91
91
  <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>
92
92
  <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">
93
93
  <ul>
94
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
94
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
95
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyFieldNameReplacer" class="tsd-anchor"></a>
96
96
  <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>
97
97
  <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">
98
98
  <ul>
99
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
99
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
100
100
  <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>
101
101
  <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>
102
102
  <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>
@@ -121,13 +121,13 @@
121
121
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
122
122
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
123
123
  <ul>
124
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
124
+ <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
125
125
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
126
126
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
127
127
  <div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
128
128
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
129
129
  <ul>
130
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
130
+ <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
131
131
  <section class="tsd-panel-group tsd-member-group">
132
132
  <h2>Accessors</h2>
133
133
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="formattedFieldList" class="tsd-anchor"></a>
@@ -137,7 +137,7 @@
137
137
  <li class="tsd-description">
138
138
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
139
139
  <ul>
140
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
141
141
  <section class="tsd-panel-group tsd-member-group">
142
142
  <h2>Methods</h2>
143
143
  <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>
@@ -157,7 +157,7 @@
157
157
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
158
158
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
159
159
  <ul>
160
- <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
160
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
161
161
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
162
162
  <div class="tsd-navigation settings">
163
163
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/enums/PlatformEnvironment.html CHANGED
@@ -16,7 +16,7 @@
16
16
  <li><a href="PlatformEnvironment.html">PlatformEnvironment</a></li></ul>
17
17
  <h1>Enumeration PlatformEnvironment</h1></div><aside class="tsd-sources">
18
18
  <ul>
19
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
19
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
20
20
  <section class="tsd-panel-group tsd-index-group">
21
21
  <section class="tsd-panel tsd-index-panel">
22
22
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,22 +35,22 @@
35
35
  <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>
36
36
  <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">
37
37
  <ul>
38
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
38
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
39
39
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Hipaa" class="tsd-anchor"></a>
40
40
  <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>
41
41
  <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">
42
42
  <ul>
43
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
43
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
44
44
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Prod" class="tsd-anchor"></a>
45
45
  <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>
46
46
  <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">
47
47
  <ul>
48
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
48
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
49
49
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stg" class="tsd-anchor"></a>
50
50
  <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>
51
51
  <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">
52
52
  <ul>
53
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
53
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
54
54
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
55
55
  <div class="tsd-navigation settings">
56
56
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html CHANGED
@@ -28,7 +28,7 @@
28
28
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
29
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
30
30
  <ul>
31
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/255f6c0/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
32
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
33
33
  <div class="tsd-navigation settings">
34
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">