@coveo/push-api-client 2.4.18 → 2.4.28

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 (47) hide show
  1. package/dist/docs/assets/highlight.css +49 -0
  2. package/dist/docs/assets/main.js +3 -3
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/assets/style.css +6 -82
  5. package/dist/docs/classes/AnySecurityIdentityBuilder.html +15 -11
  6. package/dist/docs/classes/CatalogSource.html +67 -55
  7. package/dist/docs/classes/DocumentBuilder.html +139 -112
  8. package/dist/docs/classes/FieldAnalyser.html +59 -50
  9. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +11 -7
  10. package/dist/docs/classes/PushSource.html +96 -76
  11. package/dist/docs/classes/UserSecurityIdentityBuilder.html +11 -7
  12. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +11 -7
  13. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +17 -14
  14. package/dist/docs/classes/errors.InvalidDocument.html +17 -14
  15. package/dist/docs/classes/errors.InvalidPermanentId.html +17 -14
  16. package/dist/docs/classes/errors.NotAFileError.html +17 -14
  17. package/dist/docs/classes/errors.NotAJsonFileError.html +17 -14
  18. package/dist/docs/classes/errors.PrivilegeError.html +18 -15
  19. package/dist/docs/classes/errors.UnsupportedAttribute.html +17 -14
  20. package/dist/docs/classes/errors.UnsupportedFieldError.html +27 -23
  21. package/dist/docs/enums/PlatformEnvironment.html +7 -5
  22. package/dist/docs/enums/Region.html +3 -1
  23. package/dist/docs/enums/SourceVisibility.html +3 -1
  24. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +4 -3
  25. package/dist/docs/index.html +49 -2
  26. package/dist/docs/interfaces/BatchUpdateDocuments.html +5 -3
  27. package/dist/docs/interfaces/Document.html +38 -36
  28. package/dist/docs/interfaces/SecurityIdentity.html +8 -6
  29. package/dist/docs/interfaces/SecurityIdentityBuilder.html +7 -4
  30. package/dist/docs/interfaces/UploadBatchCallbackData.html +8 -6
  31. package/dist/docs/modules/errors.html +3 -1
  32. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  33. package/dist/docs/types/CompressionType.html +1 -1
  34. package/dist/docs/types/FailedUploadCallback.html +2 -3
  35. package/dist/docs/types/Metadata.html +1 -1
  36. package/dist/docs/types/MetadataValue.html +1 -1
  37. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  38. package/dist/docs/types/SecurityIdentityType.html +1 -1
  39. package/dist/docs/types/SuccessfulUploadCallback.html +2 -3
  40. package/dist/docs/types/Transformer.html +2 -3
  41. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  42. package/dist/docs/variables/Source.html +1 -1
  43. package/dist/source/catalog.stream.spec.js +13 -0
  44. package/dist/source/catalog.stream.spec.js.map +1 -1
  45. package/dist/source/documentUploader.js +3 -2
  46. package/dist/source/documentUploader.js.map +1 -1
  47. package/package.json +13 -13
package/dist/docs/interfaces/Document.html CHANGED
@@ -19,7 +19,9 @@
19
19
  <section class="tsd-panel tsd-hierarchy">
20
20
  <h4>Hierarchy</h4>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">Document</span></li></ul></section>
22
+ <li><span class="target">Document</span></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L52">src/document.ts:52</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -27,17 +29,17 @@
27
29
  <div class="tsd-accordion-details">
28
30
  <section class="tsd-index-section">
29
31
  <h3 class="tsd-index-heading">Properties</h3>
30
- <div class="tsd-index-list"><a href="Document.html#author" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>author</span></a>
31
- <a href="Document.html#clickableUri" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>clickable<wbr/>Uri</span></a>
32
- <a href="Document.html#compressedBinaryData" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>compressed<wbr/>Binary<wbr/>Data</span></a>
33
- <a href="Document.html#data-1" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>data</span></a>
34
- <a href="Document.html#date" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>date</span></a>
35
- <a href="Document.html#fileExtension" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>file<wbr/>Extension</span></a>
36
- <a href="Document.html#metadata" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>metadata</span></a>
37
- <a href="Document.html#modifiedDate" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>modified<wbr/>Date</span></a>
38
- <a href="Document.html#parentId" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>parent<wbr/>Id</span></a>
39
- <a href="Document.html#permanentId" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>permanent<wbr/>Id</span></a>
40
- <a href="Document.html#permissions" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>permissions</span></a>
32
+ <div class="tsd-index-list"><a href="Document.html#author" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>author?</span></a>
33
+ <a href="Document.html#clickableUri" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>clickable<wbr/>Uri?</span></a>
34
+ <a href="Document.html#compressedBinaryData" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>compressed<wbr/>Binary<wbr/>Data?</span></a>
35
+ <a href="Document.html#data-1" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>data?</span></a>
36
+ <a href="Document.html#date" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>date?</span></a>
37
+ <a href="Document.html#fileExtension" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>file<wbr/>Extension?</span></a>
38
+ <a href="Document.html#metadata" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>metadata?</span></a>
39
+ <a href="Document.html#modifiedDate" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>modified<wbr/>Date?</span></a>
40
+ <a href="Document.html#parentId" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>parent<wbr/>Id?</span></a>
41
+ <a href="Document.html#permanentId" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>permanent<wbr/>Id?</span></a>
42
+ <a href="Document.html#permissions" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>permissions?</span></a>
41
43
  <a href="Document.html#title" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>title</span></a>
42
44
  <a href="Document.html#uri" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>uri</span></a>
43
45
  </div></section></div></details></section></section>
@@ -49,14 +51,14 @@
49
51
  <div class="tsd-comment tsd-typography"><p>The author of the document.</p>
50
52
  </div><aside class="tsd-sources">
51
53
  <ul>
52
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L72">src/document.ts:72</a></li></ul></aside></section>
54
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L72">src/document.ts:72</a></li></ul></aside></section>
53
55
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="clickableUri" class="tsd-anchor"></a>
54
56
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>clickable<wbr/>Uri</span><a href="#clickableUri" 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>
55
57
  <div class="tsd-signature">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
56
58
  <div class="tsd-comment tsd-typography"><p>The clickable URI associated with the document.</p>
57
59
  </div><aside class="tsd-sources">
58
60
  <ul>
59
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L68">src/document.ts:68</a></li></ul></aside></section>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L68">src/document.ts:68</a></li></ul></aside></section>
60
62
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="compressedBinaryData" class="tsd-anchor"></a>
61
63
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>compressed<wbr/>Binary<wbr/>Data</span><a href="#compressedBinaryData" 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>
62
64
  <div class="tsd-signature">compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
@@ -79,7 +81,7 @@
79
81
  <p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
80
82
  </div></li></ul></div><aside class="tsd-sources">
81
83
  <ul>
82
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L122">src/document.ts:122</a></li></ul></aside></section>
84
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L122">src/document.ts:122</a></li></ul></aside></section>
83
85
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data-1" class="tsd-anchor"></a>
84
86
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>data</span><a href="#data-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
85
87
  <div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -90,7 +92,7 @@
90
92
  <p>Example: <code>This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.</code></p>
91
93
  </div><aside class="tsd-sources">
92
94
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L110">src/document.ts:110</a></li></ul></aside></section>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L110">src/document.ts:110</a></li></ul></aside></section>
94
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="date" class="tsd-anchor"></a>
95
97
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>date</span><a href="#date" 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
98
  <div class="tsd-signature">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -98,7 +100,7 @@
98
100
  <p>Optional, will default to indexation date.</p>
99
101
  </div><aside class="tsd-sources">
100
102
  <ul>
101
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L78">src/document.ts:78</a></li></ul></aside></section>
103
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L78">src/document.ts:78</a></li></ul></aside></section>
102
104
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fileExtension" class="tsd-anchor"></a>
103
105
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>file<wbr/>Extension</span><a href="#fileExtension" 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>
104
106
  <div class="tsd-signature">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -108,7 +110,7 @@
108
110
  <p>Example: <code>.html</code></p>
109
111
  </div><aside class="tsd-sources">
110
112
  <ul>
111
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L176">src/document.ts:176</a></li></ul></aside></section>
113
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L176">src/document.ts:176</a></li></ul></aside></section>
112
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="metadata" class="tsd-anchor"></a>
113
115
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" 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>
114
116
  <div class="tsd-signature">metadata<span class="tsd-signature-symbol">?:</span> <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></div>
@@ -118,7 +120,7 @@
118
120
  <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
119
121
  </div><aside class="tsd-sources">
120
122
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L143">src/document.ts:143</a></li></ul></aside></section>
123
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L143">src/document.ts:143</a></li></ul></aside></section>
122
124
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="modifiedDate" class="tsd-anchor"></a>
123
125
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modified<wbr/>Date</span><a href="#modifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
124
126
  <div class="tsd-signature">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -126,7 +128,7 @@
126
128
  <p>Optional, will default to indexation date.</p>
127
129
  </div><aside class="tsd-sources">
128
130
  <ul>
129
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L84">src/document.ts:84</a></li></ul></aside></section>
131
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L84">src/document.ts:84</a></li></ul></aside></section>
130
132
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parentId" class="tsd-anchor"></a>
131
133
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parent<wbr/>Id</span><a href="#parentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
132
134
  <div class="tsd-signature">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -135,7 +137,7 @@
135
137
  <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
136
138
  </div><aside class="tsd-sources">
137
139
  <ul>
138
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L98">src/document.ts:98</a></li></ul></aside></section>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L98">src/document.ts:98</a></li></ul></aside></section>
139
141
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permanentId" class="tsd-anchor"></a>
140
142
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permanent<wbr/>Id</span><a href="#permanentId" 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>
141
143
  <div class="tsd-signature">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -143,7 +145,7 @@
143
145
  <p>Optional, will be derived from the document URI.</p>
144
146
  </div><aside class="tsd-sources">
145
147
  <ul>
146
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L90">src/document.ts:90</a></li></ul></aside></section>
148
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L90">src/document.ts:90</a></li></ul></aside></section>
147
149
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permissions" class="tsd-anchor"></a>
148
150
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permissions</span><a href="#permissions" 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>
149
151
  <div class="tsd-signature">permissions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>deniedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
@@ -168,14 +170,14 @@
168
170
  <div class="tsd-comment tsd-typography"><p>The list of denied permissions for this permission set.</p>
169
171
  </div></li></ul></div><aside class="tsd-sources">
170
172
  <ul>
171
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L151">src/document.ts:151</a></li></ul></aside></section>
173
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L151">src/document.ts:151</a></li></ul></aside></section>
172
174
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a>
173
175
  <h3 class="tsd-anchor-link"><span>title</span><a href="#title" 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
176
  <div class="tsd-signature">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
177
  <div class="tsd-comment tsd-typography"><p>The title of the document.</p>
176
178
  </div><aside class="tsd-sources">
177
179
  <ul>
178
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L64">src/document.ts:64</a></li></ul></aside></section>
180
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L64">src/document.ts:64</a></li></ul></aside></section>
179
181
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uri" class="tsd-anchor"></a>
180
182
  <h3 class="tsd-anchor-link"><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>
181
183
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -187,7 +189,7 @@
187
189
  </ul>
188
190
  </div><aside class="tsd-sources">
189
191
  <ul>
190
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L60">src/document.ts:60</a></li></ul></aside></section></section></div>
192
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L60">src/document.ts:60</a></li></ul></aside></section></section></div>
191
193
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
192
194
  <div class="tsd-navigation settings">
193
195
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -214,17 +216,17 @@
214
216
  <ul>
215
217
  <li class="current tsd-kind-interface"><a href="Document.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Document</span></a>
216
218
  <ul>
217
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#author" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>author</a></li>
218
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#clickableUri" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>clickable<wbr/>Uri</a></li>
219
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#compressedBinaryData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>compressed<wbr/>Binary<wbr/>Data</a></li>
220
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#data-1" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
221
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#date" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>date</a></li>
222
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#fileExtension" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>file<wbr/>Extension</a></li>
223
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#metadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>metadata</a></li>
224
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#modifiedDate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>modified<wbr/>Date</a></li>
225
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#parentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>parent<wbr/>Id</a></li>
226
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permanentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>permanent<wbr/>Id</a></li>
227
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permissions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>permissions</a></li>
219
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#author" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>author?</a></li>
220
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#clickableUri" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>clickable<wbr/>Uri?</a></li>
221
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#compressedBinaryData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>compressed<wbr/>Binary<wbr/>Data?</a></li>
222
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#data-1" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
223
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#date" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>date?</a></li>
224
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#fileExtension" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>file<wbr/>Extension?</a></li>
225
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#metadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>metadata?</a></li>
226
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#modifiedDate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>modified<wbr/>Date?</a></li>
227
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#parentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>parent<wbr/>Id?</a></li>
228
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permanentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>permanent<wbr/>Id?</a></li>
229
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permissions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>permissions?</a></li>
228
230
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#title" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>title</a></li>
229
231
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#uri" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>uri</a></li></ul></li></ul></nav></div></div>
230
232
  <div class="container tsd-generator">
package/dist/docs/interfaces/SecurityIdentity.html CHANGED
@@ -19,7 +19,9 @@
19
19
  <section class="tsd-panel tsd-hierarchy">
20
20
  <h4>Hierarchy</h4>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">SecurityIdentity</span></li></ul></section>
22
+ <li><span class="target">SecurityIdentity</span></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -29,7 +31,7 @@
29
31
  <h3 class="tsd-index-heading">Properties</h3>
30
32
  <div class="tsd-index-list"><a href="SecurityIdentity.html#identity" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>identity</span></a>
31
33
  <a href="SecurityIdentity.html#identityType" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>identity<wbr/>Type</span></a>
32
- <a href="SecurityIdentity.html#securityProvider" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>security<wbr/>Provider</span></a>
34
+ <a href="SecurityIdentity.html#securityProvider" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>security<wbr/>Provider?</span></a>
33
35
  </div></section></div></details></section></section>
34
36
  <section class="tsd-panel-group tsd-member-group">
35
37
  <h2>Properties</h2>
@@ -44,7 +46,7 @@
44
46
  </ul>
45
47
  </div><aside class="tsd-sources">
46
48
  <ul>
47
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
49
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
48
50
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a>
49
51
  <h3 class="tsd-anchor-link"><span>identity<wbr/>Type</span><a href="#identityType" 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>
50
52
  <div class="tsd-signature">identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../types/SecurityIdentityType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a></div>
@@ -58,7 +60,7 @@ Valid values:</p>
58
60
  </ul>
59
61
  </div><aside class="tsd-sources">
60
62
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
62
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a>
63
65
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
64
66
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -66,7 +68,7 @@ Valid values:</p>
66
68
  <p>Defaults to the first security identity provider associated with the target Push source.</p>
67
69
  </div><aside class="tsd-sources">
68
70
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
71
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
70
72
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
71
73
  <div class="tsd-navigation settings">
72
74
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -95,7 +97,7 @@ Valid values:</p>
95
97
  <ul>
96
98
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#identity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>identity</a></li>
97
99
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#identityType" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>identity<wbr/>Type</a></li>
98
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#securityProvider" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>security<wbr/>Provider</a></li></ul></li></ul></nav></div></div>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#securityProvider" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>security<wbr/>Provider?</a></li></ul></li></ul></nav></div></div>
99
101
  <div class="container tsd-generator">
100
102
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
101
103
  <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/interfaces/SecurityIdentityBuilder.html CHANGED
@@ -26,7 +26,9 @@
26
26
  <li><a href="../classes/AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></li>
27
27
  <li><a href="../classes/GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></li>
28
28
  <li><a href="../classes/UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li>
29
- <li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section>
29
+ <li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
30
+ <ul>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
30
32
  <section class="tsd-panel-group tsd-index-group">
31
33
  <section class="tsd-panel tsd-index-panel">
32
34
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -41,10 +43,11 @@
41
43
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="build" class="tsd-anchor"></a>
42
44
  <h3 class="tsd-anchor-link"><span>build</span><a href="#build" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
43
45
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
44
- <li class="tsd-signature" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></li></ul>
45
- <ul class="tsd-descriptions">
46
+ <li class="tsd-signature tsd-anchor-link" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><a href="#build.build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
46
47
  <li class="tsd-description">
47
- <h4 class="tsd-returns-title">Returns <a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section></div>
48
+ <h4 class="tsd-returns-title">Returns <a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
49
+ <ul>
50
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
48
51
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
49
52
  <div class="tsd-navigation settings">
50
53
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/UploadBatchCallbackData.html CHANGED
@@ -24,7 +24,9 @@
24
24
  <section class="tsd-panel tsd-hierarchy">
25
25
  <h4>Hierarchy</h4>
26
26
  <ul class="tsd-hierarchy">
27
- <li><span class="target">UploadBatchCallbackData</span></li></ul></section>
27
+ <li><span class="target">UploadBatchCallbackData</span></li></ul></section><aside class="tsd-sources">
28
+ <ul>
29
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L20">src/interfaces.ts:20</a></li></ul></aside>
28
30
  <section class="tsd-panel-group tsd-index-group">
29
31
  <section class="tsd-panel tsd-index-panel">
30
32
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,7 +36,7 @@
34
36
  <h3 class="tsd-index-heading">Properties</h3>
35
37
  <div class="tsd-index-list"><a href="UploadBatchCallbackData.html#batch" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>batch</span></a>
36
38
  <a href="UploadBatchCallbackData.html#files" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>files</span></a>
37
- <a href="UploadBatchCallbackData.html#res" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>res</span></a>
39
+ <a href="UploadBatchCallbackData.html#res" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>res?</span></a>
38
40
  </div></section></div></details></section></section>
39
41
  <section class="tsd-panel-group tsd-member-group">
40
42
  <h2>Properties</h2>
@@ -42,17 +44,17 @@
42
44
  <h3 class="tsd-anchor-link"><span>batch</span><a href="#batch" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
43
45
  <div class="tsd-signature">batch<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
44
46
  <ul>
45
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
47
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
46
48
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a>
47
49
  <h3 class="tsd-anchor-link"><span>files</span><a href="#files" 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>
48
50
  <div class="tsd-signature">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
49
51
  <ul>
50
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
52
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
51
53
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a>
52
54
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>res</span><a href="#res" 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>
53
55
  <div class="tsd-signature">res<span class="tsd-signature-symbol">?:</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></div><aside class="tsd-sources">
54
56
  <ul>
55
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
57
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
56
58
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
57
59
  <div class="tsd-navigation settings">
58
60
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -81,7 +83,7 @@
81
83
  <ul>
82
84
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#batch" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>batch</a></li>
83
85
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#files" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>files</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#res" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>res</a></li></ul></li></ul></nav></div></div>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#res" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>res?</a></li></ul></li></ul></nav></div></div>
85
87
  <div class="container tsd-generator">
86
88
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
87
89
  <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/modules/errors.html CHANGED
@@ -12,7 +12,9 @@
12
12
  <ul class="tsd-breadcrumb">
13
13
  <li><a href="../modules.html">@coveo/push-api-client</a></li>
14
14
  <li><a href="errors.html">errors</a></li></ul>
15
- <h1>Namespace errors</h1></div>
15
+ <h1>Namespace errors</h1></div><aside class="tsd-sources">
16
+ <ul>
17
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
16
18
  <section class="tsd-panel-group tsd-index-group">
17
19
  <section class="tsd-panel tsd-index-panel">
18
20
  <h3 class="tsd-index-heading uppercase">Index</h3>
package/dist/docs/types/BatchUpdateDocumentsFromFiles.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias BatchUpdateDocumentsFromFiles</h1></div>
16
16
  <div class="tsd-signature">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ConcurrentProcessing</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ParseDocumentOptions</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/interfaces.ts#L64">src/interfaces.ts:64</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L64">src/interfaces.ts:64</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/CompressionType.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <div class="tsd-comment tsd-typography"><p>The compression type that was applied to your compressed document.</p>
18
18
  </div><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L42">src/document.ts:42</a></li></ul></aside></div>
20
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L42">src/document.ts:42</a></li></ul></aside></div>
21
21
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
  <div class="tsd-navigation settings">
23
23
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/FailedUploadCallback.html CHANGED
@@ -19,8 +19,7 @@
19
19
  <ul class="tsd-parameters">
20
20
  <li class="tsd-parameter-signature">
21
21
  <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
22
- <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, value<span class="tsd-signature-symbol">: </span><a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
23
- <ul class="tsd-descriptions">
22
+ <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, value<span class="tsd-signature-symbol">: </span><a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
24
23
  <li class="tsd-description">
25
24
  <div class="tsd-parameters">
26
25
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -31,7 +30,7 @@
31
30
  <h5>value: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
32
31
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
33
32
  <ul>
34
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/help/fileConsumer.ts#L14">src/help/fileConsumer.ts:14</a></li></ul></aside></div>
33
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/help/fileConsumer.ts#L14">src/help/fileConsumer.ts:14</a></li></ul></aside></div>
35
34
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
36
35
  <div class="tsd-navigation settings">
37
36
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Metadata.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias Metadata</h1></div>
16
16
  <div class="tsd-signature">Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/MetadataValue.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias MetadataValue</h1></div>
16
16
  <div class="tsd-signature">Metadata<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/PlatformUrlOptions.html CHANGED
@@ -22,7 +22,7 @@
22
22
  <li class="tsd-parameter">
23
23
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> region<span class="tsd-signature-symbol">?: </span><a href="../enums/Region.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Region</a></h5></li></ul></div><aside class="tsd-sources">
24
24
  <ul>
25
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/environment.ts#L14">src/environment.ts:14</a></li></ul></aside></div>
25
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/environment.ts#L14">src/environment.ts:14</a></li></ul></aside></div>
26
26
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
27
27
  <div class="tsd-navigation settings">
28
28
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/SecurityIdentityType.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias SecurityIdentityType</h1></div>
16
16
  <div class="tsd-signature">Security<wbr/>Identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNKNOWN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;VIRTUAL_GROUP&quot;</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/SuccessfulUploadCallback.html CHANGED
@@ -19,8 +19,7 @@
19
19
  <ul class="tsd-parameters">
20
20
  <li class="tsd-parameter-signature">
21
21
  <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
22
- <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
23
- <ul class="tsd-descriptions">
22
+ <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
24
23
  <li class="tsd-description">
25
24
  <div class="tsd-parameters">
26
25
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -29,7 +28,7 @@
29
28
  <h5>data: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
30
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
31
30
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/help/fileConsumer.ts#L13">src/help/fileConsumer.ts:13</a></li></ul></aside></div>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/help/fileConsumer.ts#L13">src/help/fileConsumer.ts:13</a></li></ul></aside></div>
33
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
34
33
  <div class="tsd-navigation settings">
35
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Transformer.html CHANGED
@@ -19,8 +19,7 @@
19
19
  <ul class="tsd-parameters">
20
20
  <li class="tsd-parameter-signature">
21
21
  <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
22
- <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul>
23
- <ul class="tsd-descriptions">
22
+ <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
24
23
  <li class="tsd-description">
25
24
  <div class="tsd-parameters">
26
25
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -29,7 +28,7 @@
29
28
  <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
30
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
31
30
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/validation/transformers/transformer.ts#L1">src/validation/transformers/transformer.ts:1</a></li></ul></aside></div>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/validation/transformers/transformer.ts#L1">src/validation/transformers/transformer.ts:1</a></li></ul></aside></div>
33
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
34
33
  <div class="tsd-navigation settings">
35
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">