@coveo/push-api-client 2.7.15 → 2.8.0

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 (42) hide show
  1. package/dist/definitions/documentBuilder.d.ts +1 -0
  2. package/dist/docs/assets/search.js +1 -1
  3. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  4. package/dist/docs/classes/CatalogSource.html +17 -17
  5. package/dist/docs/classes/DocumentBuilder.html +41 -28
  6. package/dist/docs/classes/FieldAnalyser.html +12 -12
  7. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  8. package/dist/docs/classes/PushSource.html +24 -24
  9. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  10. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  11. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  12. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  13. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  14. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  15. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  16. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  17. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  18. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  19. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  20. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  21. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  22. package/dist/docs/interfaces/Document.html +14 -14
  23. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  24. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  25. package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
  26. package/dist/docs/modules/errors.html +1 -1
  27. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  28. package/dist/docs/types/CompressionType.html +1 -1
  29. package/dist/docs/types/FailedUploadCallback.html +1 -1
  30. package/dist/docs/types/Metadata.html +1 -1
  31. package/dist/docs/types/MetadataValue.html +1 -1
  32. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  33. package/dist/docs/types/SecurityIdentityType.html +1 -1
  34. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  35. package/dist/docs/types/Transformer.html +1 -1
  36. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  37. package/dist/docs/variables/Source.html +1 -1
  38. package/dist/documentBuilder.js +10 -1
  39. package/dist/documentBuilder.js.map +1 -1
  40. package/dist/documentBuilder.spec.js +5 -2
  41. package/dist/documentBuilder.spec.js.map +1 -1
  42. package/package.json +4 -3
package/dist/docs/classes/DocumentBuilder.html CHANGED
@@ -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/8f367e2/src/documentBuilder.ts#L14">src/documentBuilder.ts:14</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/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">
@@ -44,6 +44,7 @@
44
44
  <a href="DocumentBuilder.html#generatePermanentId" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>generate<wbr/>Permanent<wbr/>Id</span></a>
45
45
  <a href="DocumentBuilder.html#marshal" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>marshal</span></a>
46
46
  <a href="DocumentBuilder.html#marshalCompressedBinaryData" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data</span></a>
47
+ <a href="DocumentBuilder.html#marshalDocumentId" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>marshal<wbr/>Document<wbr/>Id</span></a>
47
48
  <a href="DocumentBuilder.html#marshalMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>marshal<wbr/>Metadata</span></a>
48
49
  <a href="DocumentBuilder.html#marshalPermissions" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>marshal<wbr/>Permissions</span></a>
49
50
  <a href="DocumentBuilder.html#setPermission" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Permission</span></a>
@@ -85,21 +86,21 @@
85
86
  </div></li></ul></div>
86
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">
87
88
  <ul>
88
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
89
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L23">src/documentBuilder.ts:23</a></li></ul></aside></li></ul></section></section>
89
90
  <section class="tsd-panel-group tsd-member-group">
90
91
  <h2>Properties</h2>
91
92
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="doc" class="tsd-anchor"></a>
92
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>
93
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">
94
95
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section>
96
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L17">src/documentBuilder.ts:17</a></li></ul></aside></section>
96
97
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="uri" class="tsd-anchor"></a>
97
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>
98
99
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
100
  <div class="tsd-comment tsd-typography"><p>The URI of the document. See <a href="../interfaces/Document.html#uri">uri</a></p>
100
101
  </div><aside class="tsd-sources">
101
102
  <ul>
102
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></section></section>
103
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L23">src/documentBuilder.ts:23</a></li></ul></aside></section></section>
103
104
  <section class="tsd-panel-group tsd-member-group">
104
105
  <h2>Methods</h2>
105
106
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -109,7 +110,7 @@
109
110
  <li class="tsd-description">
110
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">
111
112
  <ul>
112
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
113
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L244">src/documentBuilder.ts:244</a></li></ul></aside></li></ul></section>
113
114
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="generatePermanentId" class="tsd-anchor"></a>
114
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>
115
116
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -117,7 +118,7 @@
117
118
  <li class="tsd-description">
118
119
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
119
120
  <ul>
120
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L319">src/documentBuilder.ts:319</a></li></ul></aside></li></ul></section>
121
122
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="marshal" class="tsd-anchor"></a>
122
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>
123
124
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -128,7 +129,7 @@
128
129
  <h3>Returns</h3></div>
129
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">
130
131
  <ul>
131
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
132
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L252">src/documentBuilder.ts:252</a></li></ul></aside></li></ul></section>
132
133
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalCompressedBinaryData" class="tsd-anchor"></a>
133
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>
134
135
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -136,7 +137,18 @@
136
137
  <li class="tsd-description">
137
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">
138
139
  <ul>
139
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
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
+ <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
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
144
+ <li class="tsd-signature tsd-anchor-link" id="marshalDocumentId.marshalDocumentId-1">marshal<wbr/>Document<wbr/>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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 class="tsd-signature-symbol">}</span><a href="#marshalDocumentId.marshalDocumentId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
145
+ <li class="tsd-description">
146
+ <h4 class="tsd-returns-title">Returns <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 class="tsd-signature-symbol">}</span></h4>
147
+ <ul class="tsd-parameters">
148
+ <li class="tsd-parameter">
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
+ <ul>
151
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L265">src/documentBuilder.ts:265</a></li></ul></aside></li></ul></section>
140
152
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalMetadata" class="tsd-anchor"></a>
141
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>
142
154
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -144,7 +156,7 @@
144
156
  <li class="tsd-description">
145
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">
146
158
  <ul>
147
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
159
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L273">src/documentBuilder.ts:273</a></li></ul></aside></li></ul></section>
148
160
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalPermissions" class="tsd-anchor"></a>
149
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>
150
162
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -152,7 +164,7 @@
152
164
  <li class="tsd-description">
153
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">
154
166
  <ul>
155
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
167
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L294">src/documentBuilder.ts:294</a></li></ul></aside></li></ul></section>
156
168
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setPermission" class="tsd-anchor"></a>
157
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>
158
170
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -167,7 +179,7 @@
167
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>
168
180
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
169
181
  <ul>
170
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
182
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L337">src/documentBuilder.ts:337</a></li></ul></aside></li></ul></section>
171
183
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateAndFillMissing" class="tsd-anchor"></a>
172
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>
173
185
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -175,7 +187,7 @@
175
187
  <li class="tsd-description">
176
188
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
177
189
  <ul>
178
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
190
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
179
191
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateCompressedBinaryData" class="tsd-anchor"></a>
180
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>
181
193
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -188,7 +200,7 @@
188
200
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
189
201
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
190
202
  <ul>
191
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
203
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L330">src/documentBuilder.ts:330</a></li></ul></aside></li></ul></section>
192
204
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateDateAndReturnValidDate" class="tsd-anchor"></a>
193
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>
194
206
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -201,7 +213,7 @@
201
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>
202
214
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
203
215
  <ul>
204
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
216
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L325">src/documentBuilder.ts:325</a></li></ul></aside></li></ul></section>
205
217
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowAnonymousUsers" class="tsd-anchor"></a>
206
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>
207
219
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -217,7 +229,7 @@
217
229
  <h5>allowAnonymous: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
218
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">
219
231
  <ul>
220
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
232
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L239">src/documentBuilder.ts:239</a></li></ul></aside></li></ul></section>
221
233
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowedPermissions" class="tsd-anchor"></a>
222
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>
223
235
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -233,7 +245,7 @@
233
245
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
234
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">
235
247
  <ul>
236
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
248
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L215">src/documentBuilder.ts:215</a></li></ul></aside></li></ul></section>
237
249
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAuthor" class="tsd-anchor"></a>
238
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>
239
251
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -249,7 +261,7 @@
249
261
  <h5>author: <span class="tsd-signature-type">string</span></h5></li></ul></div>
250
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">
251
263
  <ul>
252
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
264
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L130">src/documentBuilder.ts:130</a></li></ul></aside></li></ul></section>
253
265
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withClickableUri" class="tsd-anchor"></a>
254
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>
255
267
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -265,7 +277,7 @@
265
277
  <h5>clickURI: <span class="tsd-signature-type">string</span></h5></li></ul></div>
266
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">
267
279
  <ul>
268
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
280
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L118">src/documentBuilder.ts:118</a></li></ul></aside></li></ul></section>
269
281
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withCompressedBinaryData" class="tsd-anchor"></a>
270
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>
271
283
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -283,7 +295,7 @@
283
295
  <h5>compressionType: <a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5></li></ul></div>
284
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">
285
297
  <ul>
286
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
298
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L78">src/documentBuilder.ts:78</a></li></ul></aside></li></ul></section>
287
299
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withData" class="tsd-anchor"></a>
288
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>
289
301
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -299,7 +311,7 @@
299
311
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
300
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">
301
313
  <ul>
302
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
314
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L37">src/documentBuilder.ts:37</a></li></ul></aside></li></ul></section>
303
315
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDate" class="tsd-anchor"></a>
304
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>
305
317
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -315,7 +327,7 @@
315
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>
316
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">
317
329
  <ul>
318
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
330
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L47">src/documentBuilder.ts:47</a></li></ul></aside></li></ul></section>
319
331
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDeniedPermissions" class="tsd-anchor"></a>
320
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>
321
333
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -331,7 +343,7 @@
331
343
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
332
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">
333
345
  <ul>
334
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
346
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L227">src/documentBuilder.ts:227</a></li></ul></aside></li></ul></section>
335
347
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withFileExtension" class="tsd-anchor"></a>
336
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>
337
349
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -347,7 +359,7 @@
347
359
  <h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul></div>
348
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">
349
361
  <ul>
350
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
362
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L95">src/documentBuilder.ts:95</a></li></ul></aside></li></ul></section>
351
363
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadata" class="tsd-anchor"></a>
352
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>
353
365
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -369,7 +381,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
369
381
  </div></li></ul></div>
370
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">
371
383
  <ul>
372
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
384
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L186">src/documentBuilder.ts:186</a></li></ul></aside></li></ul></section>
373
385
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadataValue" class="tsd-anchor"></a>
374
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>
375
387
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -389,7 +401,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
389
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>
390
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">
391
403
  <ul>
392
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
404
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L145">src/documentBuilder.ts:145</a></li></ul></aside></li></ul></section>
393
405
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withModifiedDate" class="tsd-anchor"></a>
394
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>
395
407
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -405,7 +417,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
405
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>
406
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">
407
419
  <ul>
408
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
420
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L57">src/documentBuilder.ts:57</a></li></ul></aside></li></ul></section>
409
421
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withParentID" class="tsd-anchor"></a>
410
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>
411
423
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -421,7 +433,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
421
433
  <h5>id: <span class="tsd-signature-type">string</span></h5></li></ul></div>
422
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">
423
435
  <ul>
424
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
436
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L108">src/documentBuilder.ts:108</a></li></ul></aside></li></ul></section>
425
437
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withPermanentId" class="tsd-anchor"></a>
426
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>
427
439
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -437,7 +449,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
437
449
  <h5>permanentID: <span class="tsd-signature-type">string</span></h5></li></ul></div>
438
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">
439
451
  <ul>
440
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8f367e2/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
452
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4f09d64/src/documentBuilder.ts#L67">src/documentBuilder.ts:67</a></li></ul></aside></li></ul></section></section></div>
441
453
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
442
454
  <div class="tsd-navigation settings">
443
455
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -471,6 +483,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
471
483
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#generatePermanentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>generate<wbr/>Permanent<wbr/>Id</a></li>
472
484
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="DocumentBuilder.html#marshal" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>marshal</a></li>
473
485
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#marshalCompressedBinaryData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data</a></li>
486
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#marshalDocumentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>marshal<wbr/>Document<wbr/>Id</a></li>
474
487
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#marshalMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>marshal<wbr/>Metadata</a></li>
475
488
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#marshalPermissions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>marshal<wbr/>Permissions</a></li>
476
489
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#setPermission" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Permission</a></li>
package/dist/docs/classes/FieldAnalyser.html CHANGED
@@ -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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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">
package/dist/docs/classes/GroupSecurityIdentityBuilder.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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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/8f367e2/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/4f09d64/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">