@coveo/push-api-client 2.5.15 → 2.5.17

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 (37) hide show
  1. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  2. package/dist/docs/classes/CatalogSource.html +14 -14
  3. package/dist/docs/classes/DocumentBuilder.html +27 -27
  4. package/dist/docs/classes/FieldAnalyser.html +11 -11
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +3 -3
  6. package/dist/docs/classes/PushSource.html +22 -22
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +3 -3
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +3 -3
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +6 -6
  10. package/dist/docs/classes/errors.InvalidDocument.html +6 -6
  11. package/dist/docs/classes/errors.InvalidPermanentId.html +6 -6
  12. package/dist/docs/classes/errors.NotAFileError.html +6 -6
  13. package/dist/docs/classes/errors.NotAJsonFileError.html +6 -6
  14. package/dist/docs/classes/errors.PrivilegeError.html +7 -7
  15. package/dist/docs/classes/errors.UnsupportedAttribute.html +6 -6
  16. package/dist/docs/classes/errors.UnsupportedFieldError.html +9 -9
  17. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  18. package/dist/docs/enums/SourceVisibility.html +4 -4
  19. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  20. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  21. package/dist/docs/interfaces/Document.html +14 -14
  22. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  23. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  24. package/dist/docs/interfaces/UploadBatchCallbackData.html +4 -4
  25. package/dist/docs/modules/errors.html +1 -1
  26. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  27. package/dist/docs/types/CompressionType.html +1 -1
  28. package/dist/docs/types/FailedUploadCallback.html +1 -1
  29. package/dist/docs/types/Metadata.html +1 -1
  30. package/dist/docs/types/MetadataValue.html +1 -1
  31. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  32. package/dist/docs/types/SecurityIdentityType.html +1 -1
  33. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  34. package/dist/docs/types/Transformer.html +1 -1
  35. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  36. package/dist/docs/variables/Source.html +1 -1
  37. package/package.json +6 -6
package/dist/docs/classes/errors.InvalidPermanentId.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">InvalidPermanentId</span></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L27">src/errors/fieldErrors.ts:27</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L27">src/errors/fieldErrors.ts:27</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -58,7 +58,7 @@
58
58
  <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">
59
59
  <p>Overrides PushApiClientBaseError.constructor</p>
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L29">src/errors/fieldErrors.ts:29</a></li></ul></aside></li></ul></section></section>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L29">src/errors/fieldErrors.ts:29</a></li></ul></aside></li></ul></section></section>
62
62
  <section class="tsd-panel-group tsd-member-group">
63
63
  <h2>Properties</h2>
64
64
  <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>
@@ -72,7 +72,7 @@
72
72
  <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">
73
73
  <p>Overrides PushApiClientBaseError.name</p>
74
74
  <ul>
75
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
76
76
  <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>
77
77
  <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>
78
78
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -103,13 +103,13 @@
103
103
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
104
104
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
105
105
  <ul>
106
- <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
106
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
107
107
  <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>
108
108
  <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>
109
109
  <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">
110
110
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
111
111
  <ul>
112
- <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
112
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
113
113
  <section class="tsd-panel-group tsd-member-group">
114
114
  <h2>Methods</h2>
115
115
  <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>
@@ -129,7 +129,7 @@
129
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
130
130
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
131
131
  <ul>
132
- <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
132
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
133
133
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
134
134
  <div class="tsd-navigation settings">
135
135
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.NotAFileError.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">NotAFileError</span></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L4">src/errors/validatorErrors.ts:4</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L4">src/errors/validatorErrors.ts:4</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -58,7 +58,7 @@
58
58
  <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">
59
59
  <p>Overrides PushApiClientBaseError.constructor</p>
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L6">src/errors/validatorErrors.ts:6</a></li></ul></aside></li></ul></section></section>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L6">src/errors/validatorErrors.ts:6</a></li></ul></aside></li></ul></section></section>
62
62
  <section class="tsd-panel-group tsd-member-group">
63
63
  <h2>Properties</h2>
64
64
  <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>
@@ -72,7 +72,7 @@
72
72
  <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">
73
73
  <p>Overrides PushApiClientBaseError.name</p>
74
74
  <ul>
75
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</a></li></ul></aside></section>
76
76
  <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>
77
77
  <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>
78
78
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -103,13 +103,13 @@
103
103
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
104
104
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
105
105
  <ul>
106
- <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
106
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
107
107
  <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>
108
108
  <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>
109
109
  <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">
110
110
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
111
111
  <ul>
112
- <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
112
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
113
113
  <section class="tsd-panel-group tsd-member-group">
114
114
  <h2>Methods</h2>
115
115
  <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>
@@ -129,7 +129,7 @@
129
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
130
130
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
131
131
  <ul>
132
- <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
132
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
133
133
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
134
134
  <div class="tsd-navigation settings">
135
135
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.NotAJsonFileError.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">NotAJsonFileError</span></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L10">src/errors/validatorErrors.ts:10</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L10">src/errors/validatorErrors.ts:10</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -58,7 +58,7 @@
58
58
  <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">
59
59
  <p>Overrides PushApiClientBaseError.constructor</p>
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L12">src/errors/validatorErrors.ts:12</a></li></ul></aside></li></ul></section></section>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L12">src/errors/validatorErrors.ts:12</a></li></ul></aside></li></ul></section></section>
62
62
  <section class="tsd-panel-group tsd-member-group">
63
63
  <h2>Properties</h2>
64
64
  <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>
@@ -72,7 +72,7 @@
72
72
  <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">
73
73
  <p>Overrides PushApiClientBaseError.name</p>
74
74
  <ul>
75
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</a></li></ul></aside></section>
76
76
  <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>
77
77
  <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>
78
78
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -103,13 +103,13 @@
103
103
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
104
104
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
105
105
  <ul>
106
- <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
106
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
107
107
  <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>
108
108
  <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>
109
109
  <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">
110
110
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
111
111
  <ul>
112
- <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
112
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
113
113
  <section class="tsd-panel-group tsd-member-group">
114
114
  <h2>Methods</h2>
115
115
  <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>
@@ -129,7 +129,7 @@
129
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
130
130
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
131
131
  <ul>
132
- <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
132
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
133
133
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
134
134
  <div class="tsd-navigation settings">
135
135
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.PrivilegeError.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">PrivilegeError</span></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/privilegeError.ts#L3">src/errors/privilegeError.ts:3</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/privilegeError.ts#L3">src/errors/privilegeError.ts:3</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -58,7 +58,7 @@
58
58
  <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">
59
59
  <p>Overrides PushApiClientBaseError.constructor</p>
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></li></ul></section></section>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></li></ul></section></section>
62
62
  <section class="tsd-panel-group tsd-member-group">
63
63
  <h2>Properties</h2>
64
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a>
@@ -66,13 +66,13 @@
66
66
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
67
67
  <p>Inherited from PushApiClientBaseError.message</p>
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
70
70
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
71
71
  <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>
72
72
  <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">
73
73
  <p>Overrides PushApiClientBaseError.name</p>
74
74
  <ul>
75
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
76
76
  <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>
77
77
  <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>
78
78
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -103,13 +103,13 @@
103
103
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
104
104
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
105
105
  <ul>
106
- <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
106
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
107
107
  <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>
108
108
  <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>
109
109
  <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">
110
110
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
111
111
  <ul>
112
- <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
112
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
113
113
  <section class="tsd-panel-group tsd-member-group">
114
114
  <h2>Methods</h2>
115
115
  <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>
@@ -129,7 +129,7 @@
129
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
130
130
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
131
131
  <ul>
132
- <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
132
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
133
133
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
134
134
  <div class="tsd-navigation settings">
135
135
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.UnsupportedAttribute.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">UnsupportedAttribute</span></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/validatorErrors.ts#L24">src/errors/validatorErrors.ts:24</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L24">src/errors/validatorErrors.ts:24</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <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.UnsupportedAttribute.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedAttribute</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/87bc09b/src/errors/validatorErrors.ts#L26">src/errors/validatorErrors.ts:26</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L26">src/errors/validatorErrors.ts:26</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>
@@ -74,7 +74,7 @@
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;Unsupported Attribute 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/87bc09b/src/errors/validatorErrors.ts#L25">src/errors/validatorErrors.ts:25</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L25">src/errors/validatorErrors.ts:25</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">
@@ -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/globals.d.ts:11</li></ul></aside></section>
108
+ <li>Defined in node_modules/@types/node/ts4.8/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/globals.d.ts:13</li></ul></aside></section></section>
114
+ <li>Defined in node_modules/@types/node/ts4.8/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/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
134
+ <li>Defined in node_modules/@types/node/ts4.8/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.UnsupportedFieldError.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">UnsupportedFieldError</span></li></ul></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -64,7 +64,7 @@
64
64
  <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">
65
65
  <p>Overrides PushApiClientBaseError.constructor</p>
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
67
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
68
68
  <section class="tsd-panel-group tsd-member-group">
69
69
  <h2>Properties</h2>
70
70
  <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>
@@ -78,7 +78,7 @@
78
78
  <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">
79
79
  <p>Overrides PushApiClientBaseError.name</p>
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
82
82
  <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>
83
83
  <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>
84
84
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -89,12 +89,12 @@
89
89
  <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>
90
90
  <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">
91
91
  <ul>
92
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
92
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
93
93
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyFieldNameReplacer" class="tsd-anchor"></a>
94
94
  <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>
95
95
  <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">
96
96
  <ul>
97
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
97
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
98
98
  <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>
99
99
  <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>
100
100
  <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>
@@ -119,13 +119,13 @@
119
119
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
120
120
  <p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
121
121
  <ul>
122
- <li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
122
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
123
123
  <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>
124
124
  <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>
125
125
  <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">
126
126
  <p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
127
127
  <ul>
128
- <li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
128
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
129
129
  <section class="tsd-panel-group tsd-member-group">
130
130
  <h2>Accessors</h2>
131
131
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="formattedFieldList" class="tsd-anchor"></a>
@@ -135,7 +135,7 @@
135
135
  <li class="tsd-description">
136
136
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
137
137
  <ul>
138
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
138
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
139
139
  <section class="tsd-panel-group tsd-member-group">
140
140
  <h2>Methods</h2>
141
141
  <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>
@@ -155,7 +155,7 @@
155
155
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
156
156
  <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
157
157
  <ul>
158
- <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
158
+ <li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
159
159
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
160
160
  <div class="tsd-navigation settings">
161
161
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/enums/PlatformEnvironment.html CHANGED
@@ -14,7 +14,7 @@
14
14
  <li><a href="PlatformEnvironment.html">PlatformEnvironment</a></li></ul>
15
15
  <h1>Enumeration PlatformEnvironment</h1></div><aside class="tsd-sources">
16
16
  <ul>
17
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
17
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
18
18
  <section class="tsd-panel-group tsd-index-group">
19
19
  <section class="tsd-panel tsd-index-panel">
20
20
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,22 +33,22 @@
33
33
  <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>
34
34
  <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">
35
35
  <ul>
36
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
36
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
37
37
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Hipaa" class="tsd-anchor"></a>
38
38
  <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>
39
39
  <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">
40
40
  <ul>
41
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
41
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
42
42
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Prod" class="tsd-anchor"></a>
43
43
  <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>
44
44
  <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">
45
45
  <ul>
46
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
46
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
47
47
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stg" class="tsd-anchor"></a>
48
48
  <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>
49
49
  <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">
50
50
  <ul>
51
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
51
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
52
52
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
53
53
  <div class="tsd-navigation settings">
54
54
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/enums/SourceVisibility.html CHANGED
@@ -14,7 +14,7 @@
14
14
  <li><a href="SourceVisibility.html">SourceVisibility</a></li></ul>
15
15
  <h1>Enumeration SourceVisibility</h1></div><aside class="tsd-sources">
16
16
  <ul>
17
- <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:144</li></ul></aside>
17
+ <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:149</li></ul></aside>
18
18
  <section class="tsd-panel-group tsd-index-group">
19
19
  <section class="tsd-panel tsd-index-panel">
20
20
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -32,17 +32,17 @@
32
32
  <h3 class="tsd-anchor-link"><span>PRIVATE</span><a href="#PRIVATE" 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>
33
33
  <div class="tsd-signature">PRIVATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PRIVATE&quot;</span></div><aside class="tsd-sources">
34
34
  <ul>
35
- <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:145</li></ul></aside></section>
35
+ <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:150</li></ul></aside></section>
36
36
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a id="SECURED" class="tsd-anchor"></a>
37
37
  <h3 class="tsd-anchor-link"><span>SECURED</span><a href="#SECURED" 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>
38
38
  <div class="tsd-signature">SECURED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;SECURED&quot;</span></div><aside class="tsd-sources">
39
39
  <ul>
40
- <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:146</li></ul></aside></section>
40
+ <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:151</li></ul></aside></section>
41
41
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a id="SHARED" class="tsd-anchor"></a>
42
42
  <h3 class="tsd-anchor-link"><span>SHARED</span><a href="#SHARED" 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>
43
43
  <div class="tsd-signature">SHARED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;SHARED&quot;</span></div><aside class="tsd-sources">
44
44
  <ul>
45
- <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:147</li></ul></aside></section></section></div>
45
+ <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:152</li></ul></aside></section></section></div>
46
46
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
47
47
  <div class="tsd-navigation settings">
48
48
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html CHANGED
@@ -26,7 +26,7 @@
26
26
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
27
27
  <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">
28
28
  <ul>
29
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
29
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
30
30
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
31
31
  <div class="tsd-navigation settings">
32
32
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/BatchUpdateDocuments.html CHANGED
@@ -18,7 +18,7 @@
18
18
  <ul class="tsd-hierarchy">
19
19
  <li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
20
20
  <ul>
21
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
21
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
22
22
  <section class="tsd-panel-group tsd-index-group">
23
23
  <section class="tsd-panel tsd-index-panel">
24
24
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,12 +35,12 @@
35
35
  <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>
36
36
  <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">
37
37
  <ul>
38
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
38
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
39
39
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
40
40
  <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>
41
41
  <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">
42
42
  <ul>
43
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/87bc09b/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
43
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
44
44
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
45
45
  <div class="tsd-navigation settings">
46
46
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">