@coveo/push-api-client 2.5.0 → 2.5.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 +14 -14
  3. package/dist/docs/classes/DocumentBuilder.html +27 -27
  4. package/dist/docs/classes/FieldAnalyser.html +11 -11
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +3 -3
  6. package/dist/docs/classes/PushSource.html +22 -22
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +3 -3
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +3 -3
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +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 +4 -4
  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 +4 -4
package/dist/docs/classes/AnySecurityIdentityBuilder.html CHANGED
@@ -31,7 +31,7 @@
31
31
  <ul class="tsd-hierarchy">
32
32
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
33
33
  <ul>
34
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
34
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
35
35
  <section class="tsd-panel-group tsd-index-group">
36
36
  <section class="tsd-panel tsd-index-panel">
37
37
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -67,14 +67,14 @@
67
67
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
68
68
  <h4 class="tsd-returns-title">Returns <a href="AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></h4><aside class="tsd-sources">
69
69
  <ul>
70
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
70
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
71
71
  <section class="tsd-panel-group tsd-member-group">
72
72
  <h2>Properties</h2>
73
73
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityIdentity" class="tsd-anchor"></a>
74
74
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>security<wbr/>Identity</span><a href="#securityIdentity" 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>
75
75
  <div class="tsd-signature">security<wbr/>Identity<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></div><aside class="tsd-sources">
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
78
78
  <section class="tsd-panel-group tsd-member-group">
79
79
  <h2>Methods</h2>
80
80
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -88,7 +88,7 @@
88
88
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></h4><aside class="tsd-sources">
89
89
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
90
90
  <ul>
91
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
91
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
92
92
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
93
93
  <div class="tsd-navigation settings">
94
94
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/CatalogSource.html CHANGED
@@ -22,7 +22,7 @@
22
22
  <ul class="tsd-hierarchy">
23
23
  <li><span class="target">CatalogSource</span></li></ul></section><aside class="tsd-sources">
24
24
  <ul>
25
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
25
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
26
26
  <section class="tsd-panel-group tsd-index-group">
27
27
  <section class="tsd-panel tsd-index-panel">
28
28
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -77,24 +77,24 @@
77
77
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol"> = CatalogSource.defaultOptions</span></h5></li></ul></div>
78
78
  <h4 class="tsd-returns-title">Returns <a href="CatalogSource.html" class="tsd-signature-type" data-tsd-kind="Class">CatalogSource</a></h4><aside class="tsd-sources">
79
79
  <ul>
80
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
80
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
81
81
  <section class="tsd-panel-group tsd-member-group">
82
82
  <h2>Properties</h2>
83
83
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
84
84
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
85
85
  <div class="tsd-signature">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
86
86
  <ul>
87
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
87
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
88
88
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
89
89
  <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>
90
90
  <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">
91
91
  <ul>
92
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
92
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
93
93
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
94
94
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>default<wbr/>Options</span><a href="#defaultOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
95
95
  <div class="tsd-signature">default<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
96
96
  <ul>
97
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
97
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
98
98
  <section class="tsd-panel-group tsd-member-group">
99
99
  <h2>Accessors</h2>
100
100
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
@@ -104,7 +104,7 @@
104
104
  <li class="tsd-description">
105
105
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
106
106
  <ul>
107
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
107
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
108
108
  <section class="tsd-panel-group tsd-member-group">
109
109
  <h2>Methods</h2>
110
110
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
@@ -126,7 +126,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
126
126
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
127
127
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
128
128
  <ul>
129
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
129
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
130
130
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
131
131
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Stream<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchStreamDocumentsFromFiles" 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>
132
132
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -150,7 +150,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
150
150
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
151
151
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
152
152
  <ul>
153
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
153
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
154
154
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
155
155
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents</span><a href="#batchUpdateDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
156
156
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -171,7 +171,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
171
171
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
172
172
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
173
173
  <ul>
174
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
174
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
175
175
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
176
176
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchUpdateDocumentsFromFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
177
177
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -194,7 +194,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
194
194
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
195
195
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
196
196
  <ul>
197
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
197
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
198
198
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
199
199
  <h3 class="tsd-anchor-link"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
200
200
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -216,7 +216,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
216
216
  </div></li></ul></div>
217
217
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
218
218
  <ul>
219
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
219
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
220
220
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
221
221
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>file<wbr/>Container<wbr/>Strategy</span><a href="#fileContainerStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
222
222
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -229,7 +229,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
229
229
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
230
230
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
231
231
  <ul>
232
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
232
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
233
233
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
234
234
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>stream<wbr/>Chunk<wbr/>Strategy</span><a href="#streamChunkStrategy" 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 tsd-is-private">
@@ -242,7 +242,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
242
242
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
243
243
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
244
244
  <ul>
245
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
245
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
246
246
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
247
247
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>url<wbr/>Builder</span><a href="#urlBuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
248
248
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -255,7 +255,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
255
255
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
256
256
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
257
257
  <ul>
258
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
258
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
259
259
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
260
260
  <div class="tsd-navigation settings">
261
261
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/DocumentBuilder.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">DocumentBuilder</span></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L14">src/documentBuilder.ts:14</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L14">src/documentBuilder.ts:14</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -82,14 +82,14 @@
82
82
  </div></li></ul></div>
83
83
  <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">
84
84
  <ul>
85
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
85
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
86
86
  <section class="tsd-panel-group tsd-member-group">
87
87
  <h2>Properties</h2>
88
88
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="doc" class="tsd-anchor"></a>
89
89
  <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>
90
90
  <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">
91
91
  <ul>
92
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section></section>
92
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section></section>
93
93
  <section class="tsd-panel-group tsd-member-group">
94
94
  <h2>Methods</h2>
95
95
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -99,7 +99,7 @@
99
99
  <li class="tsd-description">
100
100
  <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">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
102
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
103
103
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="generatePermanentId" class="tsd-anchor"></a>
104
104
  <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>
105
105
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -107,7 +107,7 @@
107
107
  <li class="tsd-description">
108
108
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
109
109
  <ul>
110
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
110
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
111
111
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="marshal" class="tsd-anchor"></a>
112
112
  <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>
113
113
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -118,7 +118,7 @@
118
118
  <h3>Returns</h3></div>
119
119
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </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>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </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>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </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>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><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </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>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </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>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </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>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><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4><aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
122
122
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalCompressedBinaryData" class="tsd-anchor"></a>
123
123
  <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>
124
124
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -126,7 +126,7 @@
126
126
  <li class="tsd-description">
127
127
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </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></h4><aside class="tsd-sources">
128
128
  <ul>
129
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
129
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
130
130
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalMetadata" class="tsd-anchor"></a>
131
131
  <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>
132
132
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -134,7 +134,7 @@
134
134
  <li class="tsd-description">
135
135
  <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">
136
136
  <ul>
137
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
137
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
138
138
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalPermissions" class="tsd-anchor"></a>
139
139
  <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>
140
140
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -142,7 +142,7 @@
142
142
  <li class="tsd-description">
143
143
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </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>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><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h4><aside class="tsd-sources">
144
144
  <ul>
145
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
145
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
146
146
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setPermission" class="tsd-anchor"></a>
147
147
  <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>
148
148
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -157,7 +157,7 @@
157
157
  <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>
158
158
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
159
159
  <ul>
160
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
160
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
161
161
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateAndFillMissing" class="tsd-anchor"></a>
162
162
  <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>
163
163
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -165,7 +165,7 @@
165
165
  <li class="tsd-description">
166
166
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
167
167
  <ul>
168
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
168
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
169
169
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateCompressedBinaryData" class="tsd-anchor"></a>
170
170
  <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>
171
171
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -178,7 +178,7 @@
178
178
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
179
179
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
180
180
  <ul>
181
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
181
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
182
182
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateDateAndReturnValidDate" class="tsd-anchor"></a>
183
183
  <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>
184
184
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -191,7 +191,7 @@
191
191
  <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>
192
192
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
193
193
  <ul>
194
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
194
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
195
195
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowAnonymousUsers" class="tsd-anchor"></a>
196
196
  <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>
197
197
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -207,7 +207,7 @@
207
207
  <h5>allowAnonymous: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
208
208
  <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">
209
209
  <ul>
210
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
210
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
211
211
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowedPermissions" class="tsd-anchor"></a>
212
212
  <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>
213
213
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -223,7 +223,7 @@
223
223
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
224
224
  <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">
225
225
  <ul>
226
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
226
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
227
227
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAuthor" class="tsd-anchor"></a>
228
228
  <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>
229
229
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -239,7 +239,7 @@
239
239
  <h5>author: <span class="tsd-signature-type">string</span></h5></li></ul></div>
240
240
  <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">
241
241
  <ul>
242
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
242
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
243
243
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withClickableUri" class="tsd-anchor"></a>
244
244
  <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>
245
245
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -255,7 +255,7 @@
255
255
  <h5>clickURI: <span class="tsd-signature-type">string</span></h5></li></ul></div>
256
256
  <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">
257
257
  <ul>
258
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
258
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
259
259
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withCompressedBinaryData" class="tsd-anchor"></a>
260
260
  <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>
261
261
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -273,7 +273,7 @@
273
273
  <h5>compressionType: <a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5></li></ul></div>
274
274
  <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">
275
275
  <ul>
276
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
276
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
277
277
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withData" class="tsd-anchor"></a>
278
278
  <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>
279
279
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -289,7 +289,7 @@
289
289
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
290
290
  <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">
291
291
  <ul>
292
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
292
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
293
293
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDate" class="tsd-anchor"></a>
294
294
  <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>
295
295
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -305,7 +305,7 @@
305
305
  <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>
306
306
  <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">
307
307
  <ul>
308
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
308
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
309
309
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDeniedPermissions" class="tsd-anchor"></a>
310
310
  <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>
311
311
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -321,7 +321,7 @@
321
321
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
322
322
  <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">
323
323
  <ul>
324
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
324
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
325
325
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withFileExtension" class="tsd-anchor"></a>
326
326
  <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>
327
327
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -337,7 +337,7 @@
337
337
  <h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul></div>
338
338
  <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">
339
339
  <ul>
340
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
340
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
341
341
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadata" class="tsd-anchor"></a>
342
342
  <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>
343
343
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -359,7 +359,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
359
359
  </div></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/0250b5a/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
362
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
363
363
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadataValue" class="tsd-anchor"></a>
364
364
  <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>
365
365
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -379,7 +379,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
379
379
  <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>
380
380
  <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">
381
381
  <ul>
382
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
382
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
383
383
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withModifiedDate" class="tsd-anchor"></a>
384
384
  <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>
385
385
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -395,7 +395,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
395
395
  <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>
396
396
  <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">
397
397
  <ul>
398
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
398
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
399
399
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withParentID" class="tsd-anchor"></a>
400
400
  <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>
401
401
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -411,7 +411,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
411
411
  <h5>id: <span class="tsd-signature-type">string</span></h5></li></ul></div>
412
412
  <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">
413
413
  <ul>
414
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
414
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
415
415
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withPermanentId" class="tsd-anchor"></a>
416
416
  <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>
417
417
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -427,7 +427,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
427
427
  <h5>permanentID: <span class="tsd-signature-type">string</span></h5></li></ul></div>
428
428
  <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">
429
429
  <ul>
430
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0250b5a/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
430
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f61b8fe/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
431
431
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
432
432
  <div class="tsd-navigation settings">
433
433
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">