@coveo/push-api-client 2.8.2 → 2.8.3

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 (36) hide show
  1. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  2. package/dist/docs/classes/CatalogSource.html +17 -17
  3. package/dist/docs/classes/DocumentBuilder.html +29 -29
  4. package/dist/docs/classes/FieldAnalyser.html +12 -12
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  6. package/dist/docs/classes/PushSource.html +24 -24
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  10. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  11. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  12. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  13. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  14. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  15. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  16. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  17. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  18. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  19. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  20. package/dist/docs/interfaces/Document.html +14 -14
  21. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  22. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  23. package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
  24. package/dist/docs/modules/errors.html +1 -1
  25. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  26. package/dist/docs/types/CompressionType.html +1 -1
  27. package/dist/docs/types/FailedUploadCallback.html +1 -1
  28. package/dist/docs/types/Metadata.html +1 -1
  29. package/dist/docs/types/MetadataValue.html +1 -1
  30. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  31. package/dist/docs/types/SecurityIdentityType.html +1 -1
  32. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  33. package/dist/docs/types/Transformer.html +1 -1
  34. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  35. package/dist/docs/variables/Source.html +1 -1
  36. package/package.json +1 -1
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">DocumentBuilder</span></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/1ef8555/src/documentBuilder.ts#L16">src/documentBuilder.ts:16</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L16">src/documentBuilder.ts:16</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">
@@ -86,21 +86,21 @@
86
86
  </div></li></ul></div>
87
87
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
88
88
  <ul>
89
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L23">src/documentBuilder.ts:23</a></li></ul></aside></li></ul></section></section>
89
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L23">src/documentBuilder.ts:23</a></li></ul></aside></li></ul></section></section>
90
90
  <section class="tsd-panel-group tsd-member-group">
91
91
  <h2>Properties</h2>
92
92
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="doc" class="tsd-anchor"></a>
93
93
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>doc</span><a href="#doc" 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>
94
94
  <div class="tsd-signature">doc<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources">
95
95
  <ul>
96
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L17">src/documentBuilder.ts:17</a></li></ul></aside></section>
96
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L17">src/documentBuilder.ts:17</a></li></ul></aside></section>
97
97
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="uri" class="tsd-anchor"></a>
98
98
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>uri</span><a href="#uri" 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>
99
99
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <div class="tsd-comment tsd-typography"><p>The URI of the document. See <a href="../interfaces/Document.html#uri">uri</a></p>
101
101
  </div><aside class="tsd-sources">
102
102
  <ul>
103
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L23">src/documentBuilder.ts:23</a></li></ul></aside></section></section>
103
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L23">src/documentBuilder.ts:23</a></li></ul></aside></section></section>
104
104
  <section class="tsd-panel-group tsd-member-group">
105
105
  <h2>Methods</h2>
106
106
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -110,7 +110,7 @@
110
110
  <li class="tsd-description">
111
111
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4><aside class="tsd-sources">
112
112
  <ul>
113
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L244">src/documentBuilder.ts:244</a></li></ul></aside></li></ul></section>
113
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L244">src/documentBuilder.ts:244</a></li></ul></aside></li></ul></section>
114
114
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="generatePermanentId" class="tsd-anchor"></a>
115
115
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>generate<wbr/>Permanent<wbr/>Id</span><a href="#generatePermanentId" 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>
116
116
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -118,7 +118,7 @@
118
118
  <li class="tsd-description">
119
119
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L319">src/documentBuilder.ts:319</a></li></ul></aside></li></ul></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L319">src/documentBuilder.ts:319</a></li></ul></aside></li></ul></section>
122
122
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="marshal" class="tsd-anchor"></a>
123
123
  <h3 class="tsd-anchor-link"><span>marshal</span><a href="#marshal" 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
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -129,7 +129,7 @@
129
129
  <h3>Returns</h3></div>
130
130
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<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"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span>        </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<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"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<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"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span>        </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<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></h4><aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L252">src/documentBuilder.ts:252</a></li></ul></aside></li></ul></section>
132
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L252">src/documentBuilder.ts:252</a></li></ul></aside></li></ul></section>
133
133
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalCompressedBinaryData" class="tsd-anchor"></a>
134
134
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#marshalCompressedBinaryData" 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>
135
135
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -137,7 +137,7 @@
137
137
  <li class="tsd-description">
138
138
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
139
139
  <ul>
140
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
141
141
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalDocumentId" class="tsd-anchor"></a>
142
142
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Document<wbr/>Id</span><a href="#marshalDocumentId" 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>
143
143
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -148,7 +148,7 @@
148
148
  <li class="tsd-parameter">
149
149
  <h5>document<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources">
150
150
  <ul>
151
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L265">src/documentBuilder.ts:265</a></li></ul></aside></li></ul></section>
151
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L265">src/documentBuilder.ts:265</a></li></ul></aside></li></ul></section>
152
152
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalMetadata" class="tsd-anchor"></a>
153
153
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Metadata</span><a href="#marshalMetadata" 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>
154
154
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -156,7 +156,7 @@
156
156
  <li class="tsd-description">
157
157
  <h4 class="tsd-returns-title">Returns <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></h4><aside class="tsd-sources">
158
158
  <ul>
159
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L273">src/documentBuilder.ts:273</a></li></ul></aside></li></ul></section>
159
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L273">src/documentBuilder.ts:273</a></li></ul></aside></li></ul></section>
160
160
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalPermissions" class="tsd-anchor"></a>
161
161
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Permissions</span><a href="#marshalPermissions" 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>
162
162
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -164,7 +164,7 @@
164
164
  <li class="tsd-description">
165
165
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span>        </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
166
166
  <ul>
167
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L294">src/documentBuilder.ts:294</a></li></ul></aside></li></ul></section>
167
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L294">src/documentBuilder.ts:294</a></li></ul></aside></li></ul></section>
168
168
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setPermission" class="tsd-anchor"></a>
169
169
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Permission</span><a href="#setPermission" 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>
170
170
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -179,7 +179,7 @@
179
179
  <h5>permissionSection: <span class="tsd-signature-type">&quot;allowedPermissions&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;deniedPermissions&quot;</span></h5></li></ul></div>
180
180
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
181
181
  <ul>
182
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L337">src/documentBuilder.ts:337</a></li></ul></aside></li></ul></section>
182
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L337">src/documentBuilder.ts:337</a></li></ul></aside></li></ul></section>
183
183
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateAndFillMissing" class="tsd-anchor"></a>
184
184
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>And<wbr/>Fill<wbr/>Missing</span><a href="#validateAndFillMissing" 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>
185
185
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -187,7 +187,7 @@
187
187
  <li class="tsd-description">
188
188
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
189
189
  <ul>
190
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
190
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
191
191
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateCompressedBinaryData" class="tsd-anchor"></a>
192
192
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#validateCompressedBinaryData" 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>
193
193
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -200,7 +200,7 @@
200
200
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
201
201
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
202
202
  <ul>
203
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L330">src/documentBuilder.ts:330</a></li></ul></aside></li></ul></section>
203
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L330">src/documentBuilder.ts:330</a></li></ul></aside></li></ul></section>
204
204
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateDateAndReturnValidDate" class="tsd-anchor"></a>
205
205
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Date<wbr/>And<wbr/>Return<wbr/>Valid<wbr/>Date</span><a href="#validateDateAndReturnValidDate" 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>
206
206
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -213,7 +213,7 @@
213
213
  <h5>d: <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>
214
214
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
215
215
  <ul>
216
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L325">src/documentBuilder.ts:325</a></li></ul></aside></li></ul></section>
216
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L325">src/documentBuilder.ts:325</a></li></ul></aside></li></ul></section>
217
217
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowAnonymousUsers" class="tsd-anchor"></a>
218
218
  <h3 class="tsd-anchor-link"><span>with<wbr/>Allow<wbr/>Anonymous<wbr/>Users</span><a href="#withAllowAnonymousUsers" 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>
219
219
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -229,7 +229,7 @@
229
229
  <h5>allowAnonymous: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
230
230
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
231
231
  <ul>
232
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L239">src/documentBuilder.ts:239</a></li></ul></aside></li></ul></section>
232
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L239">src/documentBuilder.ts:239</a></li></ul></aside></li></ul></section>
233
233
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowedPermissions" class="tsd-anchor"></a>
234
234
  <h3 class="tsd-anchor-link"><span>with<wbr/>Allowed<wbr/>Permissions</span><a href="#withAllowedPermissions" 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>
235
235
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -245,7 +245,7 @@
245
245
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
246
246
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
247
247
  <ul>
248
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L215">src/documentBuilder.ts:215</a></li></ul></aside></li></ul></section>
248
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L215">src/documentBuilder.ts:215</a></li></ul></aside></li></ul></section>
249
249
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAuthor" class="tsd-anchor"></a>
250
250
  <h3 class="tsd-anchor-link"><span>with<wbr/>Author</span><a href="#withAuthor" 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>
251
251
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -261,7 +261,7 @@
261
261
  <h5>author: <span class="tsd-signature-type">string</span></h5></li></ul></div>
262
262
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
263
263
  <ul>
264
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L130">src/documentBuilder.ts:130</a></li></ul></aside></li></ul></section>
264
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L130">src/documentBuilder.ts:130</a></li></ul></aside></li></ul></section>
265
265
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withClickableUri" class="tsd-anchor"></a>
266
266
  <h3 class="tsd-anchor-link"><span>with<wbr/>Clickable<wbr/>Uri</span><a href="#withClickableUri" 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>
267
267
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -277,7 +277,7 @@
277
277
  <h5>clickURI: <span class="tsd-signature-type">string</span></h5></li></ul></div>
278
278
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
279
279
  <ul>
280
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L118">src/documentBuilder.ts:118</a></li></ul></aside></li></ul></section>
280
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L118">src/documentBuilder.ts:118</a></li></ul></aside></li></ul></section>
281
281
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withCompressedBinaryData" class="tsd-anchor"></a>
282
282
  <h3 class="tsd-anchor-link"><span>with<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#withCompressedBinaryData" 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>
283
283
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -295,7 +295,7 @@
295
295
  <h5>compressionType: <a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5></li></ul></div>
296
296
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
297
297
  <ul>
298
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L78">src/documentBuilder.ts:78</a></li></ul></aside></li></ul></section>
298
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L78">src/documentBuilder.ts:78</a></li></ul></aside></li></ul></section>
299
299
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withData" class="tsd-anchor"></a>
300
300
  <h3 class="tsd-anchor-link"><span>with<wbr/>Data</span><a href="#withData" 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>
301
301
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -311,7 +311,7 @@
311
311
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
312
312
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
313
313
  <ul>
314
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L37">src/documentBuilder.ts:37</a></li></ul></aside></li></ul></section>
314
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L37">src/documentBuilder.ts:37</a></li></ul></aside></li></ul></section>
315
315
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDate" class="tsd-anchor"></a>
316
316
  <h3 class="tsd-anchor-link"><span>with<wbr/>Date</span><a href="#withDate" 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>
317
317
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -327,7 +327,7 @@
327
327
  <h5>date: <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>
328
328
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
329
329
  <ul>
330
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L47">src/documentBuilder.ts:47</a></li></ul></aside></li></ul></section>
330
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L47">src/documentBuilder.ts:47</a></li></ul></aside></li></ul></section>
331
331
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDeniedPermissions" class="tsd-anchor"></a>
332
332
  <h3 class="tsd-anchor-link"><span>with<wbr/>Denied<wbr/>Permissions</span><a href="#withDeniedPermissions" 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>
333
333
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -343,7 +343,7 @@
343
343
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
344
344
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
345
345
  <ul>
346
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L227">src/documentBuilder.ts:227</a></li></ul></aside></li></ul></section>
346
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L227">src/documentBuilder.ts:227</a></li></ul></aside></li></ul></section>
347
347
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withFileExtension" class="tsd-anchor"></a>
348
348
  <h3 class="tsd-anchor-link"><span>with<wbr/>File<wbr/>Extension</span><a href="#withFileExtension" 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>
349
349
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -359,7 +359,7 @@
359
359
  <h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul></div>
360
360
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
361
361
  <ul>
362
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L95">src/documentBuilder.ts:95</a></li></ul></aside></li></ul></section>
362
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L95">src/documentBuilder.ts:95</a></li></ul></aside></li></ul></section>
363
363
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadata" class="tsd-anchor"></a>
364
364
  <h3 class="tsd-anchor-link"><span>with<wbr/>Metadata</span><a href="#withMetadata" 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>
365
365
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -381,7 +381,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
381
381
  </div></li></ul></div>
382
382
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
383
383
  <ul>
384
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L186">src/documentBuilder.ts:186</a></li></ul></aside></li></ul></section>
384
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L186">src/documentBuilder.ts:186</a></li></ul></aside></li></ul></section>
385
385
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadataValue" class="tsd-anchor"></a>
386
386
  <h3 class="tsd-anchor-link"><span>with<wbr/>Metadata<wbr/>Value</span><a href="#withMetadataValue" 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>
387
387
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -401,7 +401,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
401
401
  <h5>keyTransformer: <a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol"> = BuiltInTransformers.identity</span></h5></li></ul></div>
402
402
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
403
403
  <ul>
404
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L145">src/documentBuilder.ts:145</a></li></ul></aside></li></ul></section>
404
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L145">src/documentBuilder.ts:145</a></li></ul></aside></li></ul></section>
405
405
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withModifiedDate" class="tsd-anchor"></a>
406
406
  <h3 class="tsd-anchor-link"><span>with<wbr/>Modified<wbr/>Date</span><a href="#withModifiedDate" 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>
407
407
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -417,7 +417,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
417
417
  <h5>date: <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>
418
418
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
419
419
  <ul>
420
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L57">src/documentBuilder.ts:57</a></li></ul></aside></li></ul></section>
420
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L57">src/documentBuilder.ts:57</a></li></ul></aside></li></ul></section>
421
421
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withParentID" class="tsd-anchor"></a>
422
422
  <h3 class="tsd-anchor-link"><span>with<wbr/>ParentID</span><a href="#withParentID" 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>
423
423
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -433,7 +433,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
433
433
  <h5>id: <span class="tsd-signature-type">string</span></h5></li></ul></div>
434
434
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
435
435
  <ul>
436
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L108">src/documentBuilder.ts:108</a></li></ul></aside></li></ul></section>
436
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L108">src/documentBuilder.ts:108</a></li></ul></aside></li></ul></section>
437
437
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withPermanentId" class="tsd-anchor"></a>
438
438
  <h3 class="tsd-anchor-link"><span>with<wbr/>Permanent<wbr/>Id</span><a href="#withPermanentId" 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>
439
439
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -449,7 +449,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
449
449
  <h5>permanentID: <span class="tsd-signature-type">string</span></h5></li></ul></div>
450
450
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
451
451
  <ul>
452
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/documentBuilder.ts#L67">src/documentBuilder.ts:67</a></li></ul></aside></li></ul></section></section></div>
452
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/documentBuilder.ts#L67">src/documentBuilder.ts:67</a></li></ul></aside></li></ul></section></section></div>
453
453
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
454
454
  <div class="tsd-navigation settings">
455
455
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">FieldAnalyser</span></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/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L18">src/fieldAnalyser/fieldAnalyser.ts:18</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L18">src/fieldAnalyser/fieldAnalyser.ts:18</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">
@@ -63,29 +63,29 @@
63
63
  <h5>platformClient: <span class="tsd-signature-type">PlatformClient</span></h5></li></ul></div>
64
64
  <h4 class="tsd-returns-title">Returns <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h4><aside class="tsd-sources">
65
65
  <ul>
66
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
66
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
67
67
  <section class="tsd-panel-group tsd-member-group">
68
68
  <h2>Properties</h2>
69
69
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="existingFields" class="tsd-anchor"></a>
70
70
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>existing<wbr/>Fields</span><a href="#existingFields" 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>
71
71
  <div class="tsd-signature">existing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
72
72
  <ul>
73
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
73
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
74
74
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="inconsistencies" class="tsd-anchor"></a>
75
75
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>inconsistencies</span><a href="#inconsistencies" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
76
76
  <div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
77
77
  <ul>
78
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
78
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
79
79
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="missingFields" class="tsd-anchor"></a>
80
80
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>missing<wbr/>Fields</span><a href="#missingFields" 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>
81
81
  <div class="tsd-signature">missing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldStore</span></div><aside class="tsd-sources">
82
82
  <ul>
83
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section>
83
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section>
84
84
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
85
85
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <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>
86
86
  <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">
87
87
  <ul>
88
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section></section>
88
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section></section>
89
89
  <section class="tsd-panel-group tsd-member-group">
90
90
  <h2>Methods</h2>
91
91
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
@@ -104,7 +104,7 @@ This method can be called as many time as needed as it will take into considerat
104
104
  <h5>batch: <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
105
105
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
106
106
  <ul>
107
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
107
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
108
108
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensureExistingFields" class="tsd-anchor"></a>
109
109
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Existing<wbr/>Fields</span><a href="#ensureExistingFields" 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>
110
110
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -112,7 +112,7 @@ This method can be called as many time as needed as it will take into considerat
112
112
  <li class="tsd-description">
113
113
  <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">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
114
114
  <ul>
115
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
115
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
116
116
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensurePermanentId" class="tsd-anchor"></a>
117
117
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Permanent<wbr/>Id</span><a href="#ensurePermanentId" 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>
118
118
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -125,7 +125,7 @@ This method can be called as many time as needed as it will take into considerat
125
125
  <h5>fieldStore: <span class="tsd-signature-type">FieldStore</span></h5></li></ul></div>
126
126
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
127
127
  <ul>
128
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
128
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
129
129
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="removeInconsistentFields" class="tsd-anchor"></a>
130
130
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>remove<wbr/>Inconsistent<wbr/>Fields</span><a href="#removeInconsistentFields" 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>
131
131
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -133,7 +133,7 @@ This method can be called as many time as needed as it will take into considerat
133
133
  <li class="tsd-description">
134
134
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
136
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
137
137
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="report" class="tsd-anchor"></a>
138
138
  <h3 class="tsd-anchor-link"><span>report</span><a href="#report" 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>
139
139
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -145,7 +145,7 @@ This method can be called as many time as needed as it will take into considerat
145
145
  </div>
146
146
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4><aside class="tsd-sources">
147
147
  <ul>
148
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
148
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
149
149
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="storeMetadata" class="tsd-anchor"></a>
150
150
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>store<wbr/>Metadata</span><a href="#storeMetadata" 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>
151
151
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -160,7 +160,7 @@ This method can be called as many time as needed as it will take into considerat
160
160
  <h5>metadataValue: <a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a></h5></li></ul></div>
161
161
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
162
162
  <ul>
163
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
163
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
164
164
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
165
165
  <div class="tsd-navigation settings">
166
166
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -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/1ef8555/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</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="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</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="group" class="tsd-anchor"></a>
73
73
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>group</span><a href="#group" 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">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">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</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="securityProvider" class="tsd-anchor"></a>
78
78
  <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>
79
79
  <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">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1ef8555/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</a></li></ul></aside></section></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</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/1ef8555/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</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">