@coveo/push-api-client 2.5.23 → 2.5.24

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 +16 -16
  3. package/dist/docs/classes/DocumentBuilder.html +28 -28
  4. package/dist/docs/classes/FieldAnalyser.html +12 -12
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  6. package/dist/docs/classes/PushSource.html +24 -24
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  10. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  11. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  12. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  13. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  14. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  15. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  16. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  17. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  18. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  19. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  20. package/dist/docs/interfaces/Document.html +14 -14
  21. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  22. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  23. package/dist/docs/interfaces/UploadBatchCallbackData.html +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 +1 -1
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/e2f617b/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/b427571/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/e2f617b/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/b427571/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/e2f617b/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/b427571/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/e2f617b/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/b427571/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/e2f617b/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/b427571/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">
@@ -79,34 +79,34 @@
79
79
  <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>
80
80
  <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">
81
81
  <ul>
82
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
82
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
83
83
  <section class="tsd-panel-group tsd-member-group">
84
84
  <h2>Properties</h2>
85
85
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
86
86
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>apikey</span><a href="#apikey" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
87
87
  <div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
88
88
  <ul>
89
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></section>
89
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></section>
90
90
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
91
91
  <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>
92
92
  <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">
93
93
  <ul>
94
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
94
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
95
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
96
96
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>organizationid</span><a href="#organizationid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
97
97
  <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
98
98
  <ul>
99
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
99
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
100
100
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
101
101
  <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>
102
102
  <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">
103
103
  <ul>
104
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
104
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
105
105
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
106
106
  <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>
107
107
  <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">
108
108
  <ul>
109
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
109
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
110
110
  <section class="tsd-panel-group tsd-member-group">
111
111
  <h2>Accessors</h2>
112
112
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
@@ -116,7 +116,7 @@
116
116
  <li class="tsd-description">
117
117
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
118
118
  <ul>
119
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
119
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
120
120
  <section class="tsd-panel-group tsd-member-group">
121
121
  <h2>Methods</h2>
122
122
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
@@ -138,7 +138,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
138
138
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
139
139
  <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">
140
140
  <ul>
141
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
141
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
142
142
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
143
143
  <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>
144
144
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -162,7 +162,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
162
162
  <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>
163
163
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
165
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
166
166
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
167
167
  <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>
168
168
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -183,7 +183,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
183
183
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
184
184
  <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">
185
185
  <ul>
186
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
186
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
187
187
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
188
188
  <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>
189
189
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -206,7 +206,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
206
206
  <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>
207
207
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
208
208
  <ul>
209
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
209
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
210
210
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
211
211
  <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>
212
212
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -228,7 +228,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
228
228
  </div></li></ul></div>
229
229
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
230
230
  <ul>
231
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
231
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
232
232
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
233
233
  <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>
234
234
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -241,7 +241,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
241
241
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
242
242
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
243
243
  <ul>
244
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
244
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
245
245
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
246
246
  <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>
247
247
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -254,7 +254,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
254
254
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
255
255
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
256
256
  <ul>
257
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
257
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
258
258
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
259
259
  <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>
260
260
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -267,7 +267,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
267
267
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
268
268
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
269
269
  <ul>
270
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
270
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
271
271
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
272
272
  <div class="tsd-navigation settings">
273
273
  <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/e2f617b/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/b427571/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">
@@ -83,19 +83,19 @@
83
83
  </div></li></ul></div>
84
84
  <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">
85
85
  <ul>
86
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
86
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
87
87
  <section class="tsd-panel-group tsd-member-group">
88
88
  <h2>Properties</h2>
89
89
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="doc" class="tsd-anchor"></a>
90
90
  <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>
91
91
  <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">
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section>
93
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section>
94
94
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="uri" class="tsd-anchor"></a>
95
95
  <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>
96
96
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
97
97
  <ul>
98
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></section></section>
98
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></section></section>
99
99
  <section class="tsd-panel-group tsd-member-group">
100
100
  <h2>Methods</h2>
101
101
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -105,7 +105,7 @@
105
105
  <li class="tsd-description">
106
106
  <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">
107
107
  <ul>
108
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
108
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
109
109
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="generatePermanentId" class="tsd-anchor"></a>
110
110
  <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>
111
111
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -113,7 +113,7 @@
113
113
  <li class="tsd-description">
114
114
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
116
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
117
117
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="marshal" class="tsd-anchor"></a>
118
118
  <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>
119
119
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -124,7 +124,7 @@
124
124
  <h3>Returns</h3></div>
125
125
  <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">
126
126
  <ul>
127
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
127
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
128
128
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalCompressedBinaryData" class="tsd-anchor"></a>
129
129
  <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>
130
130
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -132,7 +132,7 @@
132
132
  <li class="tsd-description">
133
133
  <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">
134
134
  <ul>
135
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
135
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
136
136
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalMetadata" class="tsd-anchor"></a>
137
137
  <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>
138
138
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -140,7 +140,7 @@
140
140
  <li class="tsd-description">
141
141
  <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">
142
142
  <ul>
143
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
143
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
144
144
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalPermissions" class="tsd-anchor"></a>
145
145
  <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>
146
146
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -148,7 +148,7 @@
148
148
  <li class="tsd-description">
149
149
  <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">
150
150
  <ul>
151
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
151
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
152
152
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setPermission" class="tsd-anchor"></a>
153
153
  <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>
154
154
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -163,7 +163,7 @@
163
163
  <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>
164
164
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
166
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
167
167
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateAndFillMissing" class="tsd-anchor"></a>
168
168
  <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>
169
169
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -171,7 +171,7 @@
171
171
  <li class="tsd-description">
172
172
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
173
173
  <ul>
174
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
174
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
175
175
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateCompressedBinaryData" class="tsd-anchor"></a>
176
176
  <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>
177
177
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -184,7 +184,7 @@
184
184
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
185
185
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
186
186
  <ul>
187
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
187
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
188
188
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateDateAndReturnValidDate" class="tsd-anchor"></a>
189
189
  <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>
190
190
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -197,7 +197,7 @@
197
197
  <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>
198
198
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
199
199
  <ul>
200
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
200
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
201
201
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowAnonymousUsers" class="tsd-anchor"></a>
202
202
  <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>
203
203
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -213,7 +213,7 @@
213
213
  <h5>allowAnonymous: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
214
214
  <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">
215
215
  <ul>
216
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
216
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
217
217
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowedPermissions" class="tsd-anchor"></a>
218
218
  <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>
219
219
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -229,7 +229,7 @@
229
229
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
230
230
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
231
231
  <ul>
232
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
232
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
233
233
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAuthor" class="tsd-anchor"></a>
234
234
  <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>
235
235
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -245,7 +245,7 @@
245
245
  <h5>author: <span class="tsd-signature-type">string</span></h5></li></ul></div>
246
246
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
247
247
  <ul>
248
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
248
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
249
249
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withClickableUri" class="tsd-anchor"></a>
250
250
  <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>
251
251
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -261,7 +261,7 @@
261
261
  <h5>clickURI: <span class="tsd-signature-type">string</span></h5></li></ul></div>
262
262
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
263
263
  <ul>
264
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
264
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
265
265
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withCompressedBinaryData" class="tsd-anchor"></a>
266
266
  <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>
267
267
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -279,7 +279,7 @@
279
279
  <h5>compressionType: <a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5></li></ul></div>
280
280
  <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">
281
281
  <ul>
282
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
282
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
283
283
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withData" class="tsd-anchor"></a>
284
284
  <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>
285
285
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -295,7 +295,7 @@
295
295
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
296
296
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
297
297
  <ul>
298
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
298
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
299
299
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDate" class="tsd-anchor"></a>
300
300
  <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>
301
301
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -311,7 +311,7 @@
311
311
  <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>
312
312
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
313
313
  <ul>
314
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
314
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
315
315
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDeniedPermissions" class="tsd-anchor"></a>
316
316
  <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>
317
317
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -327,7 +327,7 @@
327
327
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
328
328
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
329
329
  <ul>
330
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
330
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
331
331
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withFileExtension" class="tsd-anchor"></a>
332
332
  <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>
333
333
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -343,7 +343,7 @@
343
343
  <h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul></div>
344
344
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
345
345
  <ul>
346
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
346
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
347
347
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadata" class="tsd-anchor"></a>
348
348
  <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>
349
349
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -365,7 +365,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
365
365
  </div></li></ul></div>
366
366
  <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">
367
367
  <ul>
368
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
368
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
369
369
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadataValue" class="tsd-anchor"></a>
370
370
  <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>
371
371
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -385,7 +385,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
385
385
  <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>
386
386
  <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">
387
387
  <ul>
388
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
388
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
389
389
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withModifiedDate" class="tsd-anchor"></a>
390
390
  <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>
391
391
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -401,7 +401,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
401
401
  <h5>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>
402
402
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
403
403
  <ul>
404
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
404
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
405
405
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withParentID" class="tsd-anchor"></a>
406
406
  <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>
407
407
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -417,7 +417,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
417
417
  <h5>id: <span class="tsd-signature-type">string</span></h5></li></ul></div>
418
418
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
419
419
  <ul>
420
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
420
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
421
421
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withPermanentId" class="tsd-anchor"></a>
422
422
  <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>
423
423
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -433,7 +433,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
433
433
  <h5>permanentID: <span class="tsd-signature-type">string</span></h5></li></ul></div>
434
434
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
435
435
  <ul>
436
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
436
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
437
437
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
438
438
  <div class="tsd-navigation settings">
439
439
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">