@coveo/push-api-client 2.7.16 → 2.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/dist/definitions/documentBuilder.d.ts +1 -0
  2. package/dist/docs/assets/main.js +2 -52
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/assets/style.css +23 -0
  5. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  6. package/dist/docs/classes/CatalogSource.html +17 -17
  7. package/dist/docs/classes/DocumentBuilder.html +41 -28
  8. package/dist/docs/classes/FieldAnalyser.html +12 -12
  9. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  10. package/dist/docs/classes/PushSource.html +24 -24
  11. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  12. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  13. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  14. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  15. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  16. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  17. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  18. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  19. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  20. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  21. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  22. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  23. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  24. package/dist/docs/interfaces/Document.html +14 -14
  25. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  26. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  27. package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
  28. package/dist/docs/modules/errors.html +1 -1
  29. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  30. package/dist/docs/types/CompressionType.html +1 -1
  31. package/dist/docs/types/FailedUploadCallback.html +1 -1
  32. package/dist/docs/types/Metadata.html +1 -1
  33. package/dist/docs/types/MetadataValue.html +1 -1
  34. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  35. package/dist/docs/types/SecurityIdentityType.html +1 -1
  36. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  37. package/dist/docs/types/Transformer.html +1 -1
  38. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  39. package/dist/docs/variables/Source.html +1 -1
  40. package/dist/documentBuilder.js +10 -1
  41. package/dist/documentBuilder.js.map +1 -1
  42. package/dist/documentBuilder.spec.js +5 -2
  43. package/dist/documentBuilder.spec.js.map +1 -1
  44. package/package.json +7 -6
package/dist/docs/classes/PushSource.html CHANGED
@@ -24,7 +24,7 @@
24
24
  <ul class="tsd-hierarchy">
25
25
  <li><span class="target">PushSource</span></li></ul></section><aside class="tsd-sources">
26
26
  <ul>
27
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L48">src/source/push.ts:48</a></li></ul></aside>
27
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L48">src/source/push.ts:48</a></li></ul></aside>
28
28
  <section class="tsd-panel-group tsd-index-group">
29
29
  <section class="tsd-panel tsd-index-panel">
30
30
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -87,43 +87,43 @@
87
87
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a></h5></li></ul></div>
88
88
  <h4 class="tsd-returns-title">Returns <a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a></h4><aside class="tsd-sources">
89
89
  <ul>
90
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
90
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
91
91
  <section class="tsd-panel-group tsd-member-group">
92
92
  <h2>Properties</h2>
93
93
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="api" class="tsd-anchor"></a>
94
94
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>api</span><a href="#api" 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">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">APICore</span></div><aside class="tsd-sources">
96
96
  <ul>
97
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
97
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
98
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
99
99
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>apikey</span><a href="#apikey" 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">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
101
  <div class="tsd-comment tsd-typography"><p>An apiKey capable of pushing documents and managing sources in a Coveo organization. See <a href="https://docs.coveo.com/en/1718">Manage API Keys</a>.</p>
102
102
  </div><aside class="tsd-sources">
103
103
  <ul>
104
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
104
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
105
105
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
106
106
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>options</span><a href="#options" 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>
107
107
  <div class="tsd-signature">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
108
108
  <ul>
109
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
109
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
110
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
111
111
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>organizationid</span><a href="#organizationid" 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>
112
112
  <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
113
113
  <div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
114
114
  </div><aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
116
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
117
117
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
118
118
  <h3 class="tsd-anchor-link"><span>platform<wbr/>Client</span><a href="#platformClient" 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>
119
119
  <div class="tsd-signature">platform<wbr/>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformClient</span></div><aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside></section>
122
122
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
123
123
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>default<wbr/>Options</span><a href="#defaultOptions" 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>
124
124
  <div class="tsd-signature">default<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
125
125
  <ul>
126
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
126
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
127
127
  <section class="tsd-panel-group tsd-member-group">
128
128
  <h2>Accessors</h2>
129
129
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
@@ -133,7 +133,7 @@
133
133
  <li class="tsd-description">
134
134
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L166">src/source/push.ts:166</a></li></ul></aside></li></ul></section></section>
136
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L166">src/source/push.ts:166</a></li></ul></aside></li></ul></section></section>
137
137
  <section class="tsd-panel-group tsd-member-group">
138
138
  <h2>Methods</h2>
139
139
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
@@ -155,7 +155,7 @@
155
155
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
156
156
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
157
157
  <ul>
158
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L177">src/source/push.ts:177</a></li></ul></aside></li></ul></section>
158
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L177">src/source/push.ts:177</a></li></ul></aside></li></ul></section>
159
159
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
160
160
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents</span><a href="#batchUpdateDocuments" 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>
161
161
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -175,7 +175,7 @@
175
175
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
176
176
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
177
177
  <ul>
178
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L198">src/source/push.ts:198</a></li></ul></aside></li></ul></section>
178
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L198">src/source/push.ts:198</a></li></ul></aside></li></ul></section>
179
179
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
180
180
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchUpdateDocumentsFromFiles" 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>
181
181
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -198,7 +198,7 @@
198
198
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
199
199
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
200
200
  <ul>
201
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L219">src/source/push.ts:219</a></li></ul></aside></li></ul></section>
201
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L219">src/source/push.ts:219</a></li></ul></aside></li></ul></section>
202
202
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
203
203
  <h3 class="tsd-anchor-link"><span>create</span><a href="#create" 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>
204
204
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -220,7 +220,7 @@
220
220
  </div></li></ul></div>
221
221
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
222
222
  <ul>
223
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L82">src/source/push.ts:82</a></li></ul></aside></li></ul></section>
223
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L82">src/source/push.ts:82</a></li></ul></aside></li></ul></section>
224
224
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
225
225
  <h3 class="tsd-anchor-link"><span>create<wbr/>Fields</span><a href="#createFields" 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>
226
226
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -233,7 +233,7 @@
233
233
  <h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
234
234
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
235
235
  <ul>
236
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L280">src/source/push.ts:280</a></li></ul></aside></li></ul></section>
236
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L280">src/source/push.ts:280</a></li></ul></aside></li></ul></section>
237
237
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
238
238
  <h3 class="tsd-anchor-link"><span>create<wbr/>Or<wbr/>Update<wbr/>Security<wbr/>Identity<wbr/>Alias</span><a href="#createOrUpdateSecurityIdentityAlias" 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>
239
239
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -252,7 +252,7 @@
252
252
  <h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
253
253
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
254
254
  <ul>
255
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L111">src/source/push.ts:111</a></li></ul></aside></li></ul></section>
255
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L111">src/source/push.ts:111</a></li></ul></aside></li></ul></section>
256
256
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
257
257
  <h3 class="tsd-anchor-link"><span>create<wbr/>Security<wbr/>Identity</span><a href="#createSecurityIdentity" 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>
258
258
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -271,7 +271,7 @@
271
271
  <h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
272
272
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
273
273
  <ul>
274
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L96">src/source/push.ts:96</a></li></ul></aside></li></ul></section>
274
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L96">src/source/push.ts:96</a></li></ul></aside></li></ul></section>
275
275
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
276
276
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Document</span><a href="#deleteDocument" 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>
277
277
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -291,7 +291,7 @@
291
291
  <h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
292
292
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
293
293
  <ul>
294
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L239">src/source/push.ts:239</a></li></ul></aside></li></ul></section>
294
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L239">src/source/push.ts:239</a></li></ul></aside></li></ul></section>
295
295
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
296
296
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Documents<wbr/>Older<wbr/>Than</span><a href="#deleteDocumentsOlderThan" 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>
297
297
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -309,7 +309,7 @@
309
309
  <h5>olderThan: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
310
310
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
311
311
  <ul>
312
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L256">src/source/push.ts:256</a></li></ul></aside></li></ul></section>
312
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L256">src/source/push.ts:256</a></li></ul></aside></li></ul></section>
313
313
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
314
314
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Old<wbr/>Security<wbr/>Identities</span><a href="#deleteOldSecurityIdentities" 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>
315
315
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -328,7 +328,7 @@
328
328
  <h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
329
329
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
330
330
  <ul>
331
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L141">src/source/push.ts:141</a></li></ul></aside></li></ul></section>
331
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L141">src/source/push.ts:141</a></li></ul></aside></li></ul></section>
332
332
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
333
333
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Security<wbr/>Identity</span><a href="#deleteSecurityIdentity" 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>
334
334
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -347,7 +347,7 @@
347
347
  <h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
348
348
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
349
349
  <ul>
350
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L126">src/source/push.ts:126</a></li></ul></aside></li></ul></section>
350
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L126">src/source/push.ts:126</a></li></ul></aside></li></ul></section>
351
351
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
352
352
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>file<wbr/>Container<wbr/>Strategy</span><a href="#fileContainerStrategy" 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>
353
353
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -360,7 +360,7 @@
360
360
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
361
361
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
362
362
  <ul>
363
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L289">src/source/push.ts:289</a></li></ul></aside></li></ul></section>
363
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L289">src/source/push.ts:289</a></li></ul></aside></li></ul></section>
364
364
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
365
365
  <h3 class="tsd-anchor-link"><span>manage<wbr/>Security<wbr/>Identities</span><a href="#manageSecurityIdentities" 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>
366
366
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -379,7 +379,7 @@
379
379
  <h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
380
380
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
381
381
  <ul>
382
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L156">src/source/push.ts:156</a></li></ul></aside></li></ul></section>
382
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L156">src/source/push.ts:156</a></li></ul></aside></li></ul></section>
383
383
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
384
384
  <h3 class="tsd-anchor-link"><span>set<wbr/>Source<wbr/>Status</span><a href="#setSourceStatus" 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>
385
385
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -397,7 +397,7 @@
397
397
  <h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
398
398
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
399
399
  <ul>
400
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L274">src/source/push.ts:274</a></li></ul></aside></li></ul></section>
400
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L274">src/source/push.ts:274</a></li></ul></aside></li></ul></section>
401
401
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
402
402
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>url<wbr/>Builder</span><a href="#urlBuilder" 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>
403
403
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -410,7 +410,7 @@
410
410
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
411
411
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
412
412
  <ul>
413
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/source/push.ts#L285">src/source/push.ts:285</a></li></ul></aside></li></ul></section></section></div>
413
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/source/push.ts#L285">src/source/push.ts:285</a></li></ul></aside></li></ul></section></section></div>
414
414
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
415
415
  <div class="tsd-navigation settings">
416
416
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/UserSecurityIdentityBuilder.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <ul class="tsd-hierarchy">
30
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
31
31
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
33
33
  <section class="tsd-panel-group tsd-index-group">
34
34
  <section class="tsd-panel tsd-index-panel">
35
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,19 +66,19 @@
66
66
  <h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Email Security Provider&#39;</span></h5></li></ul></div>
67
67
  <h4 class="tsd-returns-title">Returns <a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</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-private"><a id="securityProvider" class="tsd-anchor"></a>
73
73
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>security<wbr/>Provider</span><a href="#securityProvider" 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">security<wbr/>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Email Security Provider&#39;</span></div><aside class="tsd-sources">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="user" class="tsd-anchor"></a>
78
78
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>user</span><a href="#user" 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>
79
79
  <div class="tsd-signature">user<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></div><aside class="tsd-sources">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
82
82
  <section class="tsd-panel-group tsd-member-group">
83
83
  <h2>Methods</h2>
84
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -92,7 +92,7 @@
92
92
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
93
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
96
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
97
97
  <div class="tsd-navigation settings">
98
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <ul class="tsd-hierarchy">
30
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
31
31
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
33
33
  <section class="tsd-panel-group tsd-index-group">
34
34
  <section class="tsd-panel tsd-index-panel">
35
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,19 +66,19 @@
66
66
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
67
67
  <h4 class="tsd-returns-title">Returns <a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</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-private"><a id="securityProvider" class="tsd-anchor"></a>
73
73
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" 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">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="virtualGroup" class="tsd-anchor"></a>
78
78
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>virtual<wbr/>Group</span><a href="#virtualGroup" 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>
79
79
  <div class="tsd-signature">virtual<wbr/>Group<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></div><aside class="tsd-sources">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
82
82
  <section class="tsd-panel-group tsd-member-group">
83
83
  <h2>Methods</h2>
84
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -92,7 +92,7 @@
92
92
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
93
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/72ffd15/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
96
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
97
97
  <div class="tsd-navigation settings">
98
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.FieldTypeInconsistencyError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">FieldTypeInconsistencyError</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/72ffd15/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</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.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</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/72ffd15/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</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;Field Type Inconsistency 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/72ffd15/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</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">
package/dist/docs/classes/errors.InvalidDocument.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">InvalidDocument</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/72ffd15/src/errors/validatorErrors.ts#L17">src/errors/validatorErrors.ts:17</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/validatorErrors.ts#L17">src/errors/validatorErrors.ts:17</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.InvalidDocument.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidDocument</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/72ffd15/src/errors/validatorErrors.ts#L19">src/errors/validatorErrors.ts:19</a></li></ul></aside></li></ul></section></section>
65
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/validatorErrors.ts#L19">src/errors/validatorErrors.ts:19</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>
@@ -76,7 +76,7 @@
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;Invalid JSON Document 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/72ffd15/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
79
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</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">
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/72ffd15/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/27ba71c/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/72ffd15/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/27ba71c/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>
@@ -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;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/72ffd15/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/27ba71c/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">
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/72ffd15/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/27ba71c/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/72ffd15/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/27ba71c/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>
@@ -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;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/72ffd15/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/27ba71c/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">
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/72ffd15/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/27ba71c/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/72ffd15/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/27ba71c/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>
@@ -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;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/72ffd15/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/27ba71c/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">
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/72ffd15/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/27ba71c/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/72ffd15/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/27ba71c/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,13 +68,13 @@
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/72ffd15/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/27ba71c/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/72ffd15/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/27ba71c/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">