@coveo/push-api-client 2.6.3 → 2.6.4

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 +5 -5
  24. package/dist/docs/modules/errors.html +1 -1
  25. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  26. package/dist/docs/types/CompressionType.html +1 -1
  27. package/dist/docs/types/FailedUploadCallback.html +1 -1
  28. package/dist/docs/types/Metadata.html +1 -1
  29. package/dist/docs/types/MetadataValue.html +1 -1
  30. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  31. package/dist/docs/types/SecurityIdentityType.html +1 -1
  32. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  33. package/dist/docs/types/Transformer.html +1 -1
  34. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  35. package/dist/docs/variables/Source.html +1 -1
  36. package/package.json +8 -8
package/dist/docs/classes/AnySecurityIdentityBuilder.html CHANGED
@@ -33,7 +33,7 @@
33
33
  <ul class="tsd-hierarchy">
34
34
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
35
35
  <ul>
36
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
36
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
37
37
  <section class="tsd-panel-group tsd-index-group">
38
38
  <section class="tsd-panel tsd-index-panel">
39
39
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -69,14 +69,14 @@
69
69
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
70
70
  <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">
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
73
73
  <section class="tsd-panel-group tsd-member-group">
74
74
  <h2>Properties</h2>
75
75
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityIdentity" class="tsd-anchor"></a>
76
76
  <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>
77
77
  <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">
78
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
79
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
80
80
  <section class="tsd-panel-group tsd-member-group">
81
81
  <h2>Methods</h2>
82
82
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +90,7 @@
90
90
  <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">
91
91
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
93
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
94
94
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
95
  <div class="tsd-navigation settings">
96
96
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/CatalogSource.html CHANGED
@@ -24,7 +24,7 @@
24
24
  <ul class="tsd-hierarchy">
25
25
  <li><span class="target">CatalogSource</span></li></ul></section><aside class="tsd-sources">
26
26
  <ul>
27
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
27
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
28
28
  <section class="tsd-panel-group tsd-index-group">
29
29
  <section class="tsd-panel tsd-index-panel">
30
30
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -81,7 +81,7 @@
81
81
  <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>
82
82
  <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">
83
83
  <ul>
84
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
84
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
85
85
  <section class="tsd-panel-group tsd-member-group">
86
86
  <h2>Properties</h2>
87
87
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
@@ -90,29 +90,29 @@
90
90
  <div class="tsd-comment tsd-typography"><p>An apiKey capable of pushing documents and managing sources in a Coveo organization. See <a href="https://docs.coveo.com/en/1718">Manage API Keys</a>.</p>
91
91
  </div><aside class="tsd-sources">
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></section>
93
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L46">src/source/catalog.ts:46</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="options" class="tsd-anchor"></a>
95
95
  <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>
96
96
  <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">
97
97
  <ul>
98
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
98
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
99
99
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
100
100
  <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>
101
101
  <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
102
  <div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
103
103
  </div><aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
105
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
106
106
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
107
107
  <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>
108
108
  <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">
109
109
  <ul>
110
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
110
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
111
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
112
112
  <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>
113
113
  <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">
114
114
  <ul>
115
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
115
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
116
116
  <section class="tsd-panel-group tsd-member-group">
117
117
  <h2>Accessors</h2>
118
118
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
@@ -122,7 +122,7 @@
122
122
  <li class="tsd-description">
123
123
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
124
124
  <ul>
125
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
125
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
126
126
  <section class="tsd-panel-group tsd-member-group">
127
127
  <h2>Methods</h2>
128
128
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
@@ -144,7 +144,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
144
144
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
145
145
  <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">
146
146
  <ul>
147
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
147
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
148
148
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
149
149
  <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>
150
150
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -168,7 +168,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
168
168
  <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>
169
169
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
170
170
  <ul>
171
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
171
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
172
172
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
173
173
  <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>
174
174
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -189,7 +189,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
189
189
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
190
190
  <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">
191
191
  <ul>
192
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
192
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
193
193
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
194
194
  <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>
195
195
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -212,7 +212,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
212
212
  <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>
213
213
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
214
214
  <ul>
215
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
215
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
216
216
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
217
217
  <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>
218
218
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -234,7 +234,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
234
234
  </div></li></ul></div>
235
235
  <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">
236
236
  <ul>
237
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
237
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
238
238
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
239
239
  <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>
240
240
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -247,7 +247,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
247
247
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
248
248
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
249
249
  <ul>
250
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
250
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
251
251
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
252
252
  <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>
253
253
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -260,7 +260,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
260
260
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
261
261
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
262
262
  <ul>
263
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
263
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
264
264
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
265
265
  <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>
266
266
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -273,7 +273,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
273
273
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
274
274
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
275
275
  <ul>
276
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
276
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
277
277
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
278
278
  <div class="tsd-navigation settings">
279
279
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/DocumentBuilder.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">DocumentBuilder</span></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L14">src/documentBuilder.ts:14</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L14">src/documentBuilder.ts:14</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -85,21 +85,21 @@
85
85
  </div></li></ul></div>
86
86
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
87
87
  <ul>
88
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
88
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
89
89
  <section class="tsd-panel-group tsd-member-group">
90
90
  <h2>Properties</h2>
91
91
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="doc" class="tsd-anchor"></a>
92
92
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>doc</span><a href="#doc" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
93
93
  <div class="tsd-signature">doc<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources">
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section>
96
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="uri" class="tsd-anchor"></a>
97
97
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>uri</span><a href="#uri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
98
98
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <div class="tsd-comment tsd-typography"><p>The URI of the document. See <a href="../interfaces/Document.html#uri">uri</a></p>
100
100
  </div><aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></section></section>
102
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></section></section>
103
103
  <section class="tsd-panel-group tsd-member-group">
104
104
  <h2>Methods</h2>
105
105
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -109,7 +109,7 @@
109
109
  <li class="tsd-description">
110
110
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4><aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
112
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
113
113
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="generatePermanentId" class="tsd-anchor"></a>
114
114
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>generate<wbr/>Permanent<wbr/>Id</span><a href="#generatePermanentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
115
115
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -117,7 +117,7 @@
117
117
  <li class="tsd-description">
118
118
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
119
119
  <ul>
120
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
120
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
121
121
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="marshal" class="tsd-anchor"></a>
122
122
  <h3 class="tsd-anchor-link"><span>marshal</span><a href="#marshal" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
123
123
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -128,7 +128,7 @@
128
128
  <h3>Returns</h3></div>
129
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>allowedPermissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>deniedPermissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>allowedPermissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>deniedPermissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
130
130
  <ul>
131
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
131
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
132
132
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalCompressedBinaryData" class="tsd-anchor"></a>
133
133
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#marshalCompressedBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
134
134
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -136,7 +136,7 @@
136
136
  <li class="tsd-description">
137
137
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
138
138
  <ul>
139
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
139
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
140
140
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalMetadata" class="tsd-anchor"></a>
141
141
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Metadata</span><a href="#marshalMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
142
142
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -144,7 +144,7 @@
144
144
  <li class="tsd-description">
145
145
  <h4 class="tsd-returns-title">Returns <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></h4><aside class="tsd-sources">
146
146
  <ul>
147
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
147
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
148
148
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalPermissions" class="tsd-anchor"></a>
149
149
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Permissions</span><a href="#marshalPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
150
150
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -152,7 +152,7 @@
152
152
  <li class="tsd-description">
153
153
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>allowedPermissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>deniedPermissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
154
154
  <ul>
155
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
155
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
156
156
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setPermission" class="tsd-anchor"></a>
157
157
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Permission</span><a href="#setPermission" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
158
158
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -167,7 +167,7 @@
167
167
  <h5>permissionSection: <span class="tsd-signature-type">&quot;allowedPermissions&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;deniedPermissions&quot;</span></h5></li></ul></div>
168
168
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
169
169
  <ul>
170
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
170
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
171
171
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateAndFillMissing" class="tsd-anchor"></a>
172
172
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>And<wbr/>Fill<wbr/>Missing</span><a href="#validateAndFillMissing" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
173
173
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -175,7 +175,7 @@
175
175
  <li class="tsd-description">
176
176
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
177
177
  <ul>
178
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
178
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
179
179
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateCompressedBinaryData" class="tsd-anchor"></a>
180
180
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#validateCompressedBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
181
181
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -188,7 +188,7 @@
188
188
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
189
189
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
190
190
  <ul>
191
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
191
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
192
192
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateDateAndReturnValidDate" class="tsd-anchor"></a>
193
193
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Date<wbr/>And<wbr/>Return<wbr/>Valid<wbr/>Date</span><a href="#validateDateAndReturnValidDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
194
194
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -201,7 +201,7 @@
201
201
  <h5>d: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
202
202
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
203
203
  <ul>
204
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
204
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
205
205
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowAnonymousUsers" class="tsd-anchor"></a>
206
206
  <h3 class="tsd-anchor-link"><span>with<wbr/>Allow<wbr/>Anonymous<wbr/>Users</span><a href="#withAllowAnonymousUsers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
207
207
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -217,7 +217,7 @@
217
217
  <h5>allowAnonymous: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
218
218
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
219
219
  <ul>
220
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
220
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
221
221
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowedPermissions" class="tsd-anchor"></a>
222
222
  <h3 class="tsd-anchor-link"><span>with<wbr/>Allowed<wbr/>Permissions</span><a href="#withAllowedPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
223
223
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -233,7 +233,7 @@
233
233
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
234
234
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
235
235
  <ul>
236
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
236
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
237
237
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAuthor" class="tsd-anchor"></a>
238
238
  <h3 class="tsd-anchor-link"><span>with<wbr/>Author</span><a href="#withAuthor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
239
239
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -249,7 +249,7 @@
249
249
  <h5>author: <span class="tsd-signature-type">string</span></h5></li></ul></div>
250
250
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
251
251
  <ul>
252
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
252
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
253
253
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withClickableUri" class="tsd-anchor"></a>
254
254
  <h3 class="tsd-anchor-link"><span>with<wbr/>Clickable<wbr/>Uri</span><a href="#withClickableUri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
255
255
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -265,7 +265,7 @@
265
265
  <h5>clickURI: <span class="tsd-signature-type">string</span></h5></li></ul></div>
266
266
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
267
267
  <ul>
268
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
268
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
269
269
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withCompressedBinaryData" class="tsd-anchor"></a>
270
270
  <h3 class="tsd-anchor-link"><span>with<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#withCompressedBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
271
271
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -283,7 +283,7 @@
283
283
  <h5>compressionType: <a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5></li></ul></div>
284
284
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
285
285
  <ul>
286
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
286
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
287
287
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withData" class="tsd-anchor"></a>
288
288
  <h3 class="tsd-anchor-link"><span>with<wbr/>Data</span><a href="#withData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
289
289
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -299,7 +299,7 @@
299
299
  <h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
300
300
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
301
301
  <ul>
302
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
302
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
303
303
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDate" class="tsd-anchor"></a>
304
304
  <h3 class="tsd-anchor-link"><span>with<wbr/>Date</span><a href="#withDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
305
305
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -315,7 +315,7 @@
315
315
  <h5>date: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
316
316
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
317
317
  <ul>
318
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
318
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
319
319
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDeniedPermissions" class="tsd-anchor"></a>
320
320
  <h3 class="tsd-anchor-link"><span>with<wbr/>Denied<wbr/>Permissions</span><a href="#withDeniedPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
321
321
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -331,7 +331,7 @@
331
331
  <h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
332
332
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
333
333
  <ul>
334
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
334
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
335
335
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withFileExtension" class="tsd-anchor"></a>
336
336
  <h3 class="tsd-anchor-link"><span>with<wbr/>File<wbr/>Extension</span><a href="#withFileExtension" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
337
337
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -347,7 +347,7 @@
347
347
  <h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul></div>
348
348
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
349
349
  <ul>
350
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
350
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
351
351
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadata" class="tsd-anchor"></a>
352
352
  <h3 class="tsd-anchor-link"><span>with<wbr/>Metadata</span><a href="#withMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
353
353
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -369,7 +369,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
369
369
  </div></li></ul></div>
370
370
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
371
371
  <ul>
372
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
372
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
373
373
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadataValue" class="tsd-anchor"></a>
374
374
  <h3 class="tsd-anchor-link"><span>with<wbr/>Metadata<wbr/>Value</span><a href="#withMetadataValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
375
375
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -389,7 +389,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
389
389
  <h5>keyTransformer: <a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol"> = BuiltInTransformers.identity</span></h5></li></ul></div>
390
390
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
391
391
  <ul>
392
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
392
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
393
393
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withModifiedDate" class="tsd-anchor"></a>
394
394
  <h3 class="tsd-anchor-link"><span>with<wbr/>Modified<wbr/>Date</span><a href="#withModifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
395
395
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -405,7 +405,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
405
405
  <h5>date: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
406
406
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
407
407
  <ul>
408
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
408
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
409
409
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withParentID" class="tsd-anchor"></a>
410
410
  <h3 class="tsd-anchor-link"><span>with<wbr/>ParentID</span><a href="#withParentID" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
411
411
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -421,7 +421,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
421
421
  <h5>id: <span class="tsd-signature-type">string</span></h5></li></ul></div>
422
422
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
423
423
  <ul>
424
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
424
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
425
425
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withPermanentId" class="tsd-anchor"></a>
426
426
  <h3 class="tsd-anchor-link"><span>with<wbr/>Permanent<wbr/>Id</span><a href="#withPermanentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
427
427
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -437,7 +437,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
437
437
  <h5>permanentID: <span class="tsd-signature-type">string</span></h5></li></ul></div>
438
438
  <h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
439
439
  <ul>
440
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b24edb2/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
440
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/575faa5/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
441
441
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
442
442
  <div class="tsd-navigation settings">
443
443
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">