@coveo/push-api-client 2.4.27 → 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 (36) hide show
  1. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  2. package/dist/docs/classes/CatalogSource.html +14 -14
  3. package/dist/docs/classes/DocumentBuilder.html +27 -27
  4. package/dist/docs/classes/FieldAnalyser.html +11 -11
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +3 -3
  6. package/dist/docs/classes/PushSource.html +22 -22
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +3 -3
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +3 -3
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +7 -7
  10. package/dist/docs/classes/errors.InvalidDocument.html +7 -7
  11. package/dist/docs/classes/errors.InvalidPermanentId.html +7 -7
  12. package/dist/docs/classes/errors.NotAFileError.html +7 -7
  13. package/dist/docs/classes/errors.NotAJsonFileError.html +7 -7
  14. package/dist/docs/classes/errors.PrivilegeError.html +8 -8
  15. package/dist/docs/classes/errors.UnsupportedAttribute.html +7 -7
  16. package/dist/docs/classes/errors.UnsupportedFieldError.html +10 -10
  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 +36 -36
  21. package/dist/docs/interfaces/SecurityIdentity.html +6 -6
  22. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  23. package/dist/docs/interfaces/UploadBatchCallbackData.html +6 -6
  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 +6 -6
package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html CHANGED
@@ -26,7 +26,7 @@
26
26
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
27
27
  <h4 class="tsd-returns-title">Returns <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
28
28
  <ul>
29
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
29
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
30
30
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
31
31
  <div class="tsd-navigation settings">
32
32
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/BatchUpdateDocuments.html CHANGED
@@ -18,7 +18,7 @@
18
18
  <ul class="tsd-hierarchy">
19
19
  <li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
20
20
  <ul>
21
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
21
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
22
22
  <section class="tsd-panel-group tsd-index-group">
23
23
  <section class="tsd-panel tsd-index-panel">
24
24
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,12 +35,12 @@
35
35
  <h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update</span><a href="#addOrUpdate" 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>
36
36
  <div class="tsd-signature">add<wbr/>Or<wbr/>Update<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">
37
37
  <ul>
38
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
38
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
39
39
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
40
40
  <h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" 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>
41
41
  <div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
42
42
  <ul>
43
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
43
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
44
44
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
45
45
  <div class="tsd-navigation settings">
46
46
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/Document.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">Document</span></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/document.ts#L52">src/document.ts:52</a></li></ul></aside>
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>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -29,17 +29,17 @@
29
29
  <div class="tsd-accordion-details">
30
30
  <section class="tsd-index-section">
31
31
  <h3 class="tsd-index-heading">Properties</h3>
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>
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>
43
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>
44
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>
45
45
  </div></section></div></details></section></section>
@@ -51,14 +51,14 @@
51
51
  <div class="tsd-comment tsd-typography"><p>The author of the document.</p>
52
52
  </div><aside class="tsd-sources">
53
53
  <ul>
54
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
55
55
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="clickableUri" class="tsd-anchor"></a>
56
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>
57
57
  <div class="tsd-signature">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
58
58
  <div class="tsd-comment tsd-typography"><p>The clickable URI associated with the document.</p>
59
59
  </div><aside class="tsd-sources">
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
62
62
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="compressedBinaryData" class="tsd-anchor"></a>
63
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>
64
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>
@@ -81,7 +81,7 @@
81
81
  <p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
82
82
  </div></li></ul></div><aside class="tsd-sources">
83
83
  <ul>
84
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
85
85
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data-1" class="tsd-anchor"></a>
86
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>
87
87
  <div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -92,7 +92,7 @@
92
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>
93
93
  </div><aside class="tsd-sources">
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
96
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="date" class="tsd-anchor"></a>
97
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>
98
98
  <div class="tsd-signature">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -100,7 +100,7 @@
100
100
  <p>Optional, will default to indexation date.</p>
101
101
  </div><aside class="tsd-sources">
102
102
  <ul>
103
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
104
104
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fileExtension" class="tsd-anchor"></a>
105
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>
106
106
  <div class="tsd-signature">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -110,7 +110,7 @@
110
110
  <p>Example: <code>.html</code></p>
111
111
  </div><aside class="tsd-sources">
112
112
  <ul>
113
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
114
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="metadata" class="tsd-anchor"></a>
115
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>
116
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>
@@ -120,7 +120,7 @@
120
120
  <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
121
121
  </div><aside class="tsd-sources">
122
122
  <ul>
123
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
124
124
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="modifiedDate" class="tsd-anchor"></a>
125
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>
126
126
  <div class="tsd-signature">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -128,7 +128,7 @@
128
128
  <p>Optional, will default to indexation date.</p>
129
129
  </div><aside class="tsd-sources">
130
130
  <ul>
131
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
132
132
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parentId" class="tsd-anchor"></a>
133
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>
134
134
  <div class="tsd-signature">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -137,7 +137,7 @@
137
137
  <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
138
138
  </div><aside class="tsd-sources">
139
139
  <ul>
140
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
141
141
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permanentId" class="tsd-anchor"></a>
142
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>
143
143
  <div class="tsd-signature">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -145,7 +145,7 @@
145
145
  <p>Optional, will be derived from the document URI.</p>
146
146
  </div><aside class="tsd-sources">
147
147
  <ul>
148
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
149
149
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permissions" class="tsd-anchor"></a>
150
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>
151
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>
@@ -170,14 +170,14 @@
170
170
  <div class="tsd-comment tsd-typography"><p>The list of denied permissions for this permission set.</p>
171
171
  </div></li></ul></div><aside class="tsd-sources">
172
172
  <ul>
173
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
174
174
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a>
175
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>
176
176
  <div class="tsd-signature">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
177
177
  <div class="tsd-comment tsd-typography"><p>The title of the document.</p>
178
178
  </div><aside class="tsd-sources">
179
179
  <ul>
180
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
181
181
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uri" class="tsd-anchor"></a>
182
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>
183
183
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -189,7 +189,7 @@
189
189
  </ul>
190
190
  </div><aside class="tsd-sources">
191
191
  <ul>
192
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
193
193
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
194
194
  <div class="tsd-navigation settings">
195
195
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -216,17 +216,17 @@
216
216
  <ul>
217
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>
218
218
  <ul>
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>
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>
230
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>
231
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>
232
232
  <div class="container tsd-generator">
package/dist/docs/interfaces/SecurityIdentity.html CHANGED
@@ -21,7 +21,7 @@
21
21
  <ul class="tsd-hierarchy">
22
22
  <li><span class="target">SecurityIdentity</span></li></ul></section><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
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>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -31,7 +31,7 @@
31
31
  <h3 class="tsd-index-heading">Properties</h3>
32
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>
33
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>
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>
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>
35
35
  </div></section></div></details></section></section>
36
36
  <section class="tsd-panel-group tsd-member-group">
37
37
  <h2>Properties</h2>
@@ -46,7 +46,7 @@
46
46
  </ul>
47
47
  </div><aside class="tsd-sources">
48
48
  <ul>
49
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
50
50
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a>
51
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>
52
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>
@@ -60,7 +60,7 @@ Valid values:</p>
60
60
  </ul>
61
61
  </div><aside class="tsd-sources">
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
64
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a>
65
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>
66
66
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -68,7 +68,7 @@ Valid values:</p>
68
68
  <p>Defaults to the first security identity provider associated with the target Push source.</p>
69
69
  </div><aside class="tsd-sources">
70
70
  <ul>
71
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
72
72
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
73
73
  <div class="tsd-navigation settings">
74
74
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -97,7 +97,7 @@ Valid values:</p>
97
97
  <ul>
98
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>
99
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>
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>
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>
101
101
  <div class="container tsd-generator">
102
102
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
103
103
  <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/interfaces/SecurityIdentityBuilder.html CHANGED
@@ -28,7 +28,7 @@
28
28
  <li><a href="../classes/UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li>
29
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
30
  <ul>
31
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
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>
32
32
  <section class="tsd-panel-group tsd-index-group">
33
33
  <section class="tsd-panel tsd-index-panel">
34
34
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -47,7 +47,7 @@
47
47
  <li class="tsd-description">
48
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
49
  <ul>
50
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
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>
51
51
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
52
52
  <div class="tsd-navigation settings">
53
53
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/UploadBatchCallbackData.html CHANGED
@@ -26,7 +26,7 @@
26
26
  <ul class="tsd-hierarchy">
27
27
  <li><span class="target">UploadBatchCallbackData</span></li></ul></section><aside class="tsd-sources">
28
28
  <ul>
29
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/interfaces.ts#L20">src/interfaces.ts:20</a></li></ul></aside>
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>
30
30
  <section class="tsd-panel-group tsd-index-group">
31
31
  <section class="tsd-panel tsd-index-panel">
32
32
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,7 +36,7 @@
36
36
  <h3 class="tsd-index-heading">Properties</h3>
37
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>
38
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>
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>
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>
40
40
  </div></section></div></details></section></section>
41
41
  <section class="tsd-panel-group tsd-member-group">
42
42
  <h2>Properties</h2>
@@ -44,17 +44,17 @@
44
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>
45
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">
46
46
  <ul>
47
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
48
48
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a>
49
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>
50
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">
51
51
  <ul>
52
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
53
53
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a>
54
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>
55
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">
56
56
  <ul>
57
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
58
58
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
59
59
  <div class="tsd-navigation settings">
60
60
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -83,7 +83,7 @@
83
83
  <ul>
84
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>
85
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>
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>
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>
87
87
  <div class="container tsd-generator">
88
88
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
89
89
  <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/modules/errors.html CHANGED
@@ -14,7 +14,7 @@
14
14
  <li><a href="errors.html">errors</a></li></ul>
15
15
  <h1>Namespace errors</h1></div><aside class="tsd-sources">
16
16
  <ul>
17
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
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>
18
18
  <section class="tsd-panel-group tsd-index-group">
19
19
  <section class="tsd-panel tsd-index-panel">
20
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/4dd7c9a/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/4dd7c9a/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
@@ -30,7 +30,7 @@
30
30
  <h5>value: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
31
31
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
32
32
  <ul>
33
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
34
34
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
35
35
  <div class="tsd-navigation settings">
36
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/4dd7c9a/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/4dd7c9a/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/4dd7c9a/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/4dd7c9a/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
@@ -28,7 +28,7 @@
28
28
  <h5>data: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
29
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
30
30
  <ul>
31
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
32
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
33
33
  <div class="tsd-navigation settings">
34
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Transformer.html CHANGED
@@ -28,7 +28,7 @@
28
28
  <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
29
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
30
30
  <ul>
31
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/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>
32
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
33
33
  <div class="tsd-navigation settings">
34
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/variables/BuiltInTransformers.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Variable BuiltInTransformers<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
16
16
  <div class="tsd-signature">Built<wbr/>In<wbr/>Transformers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>identity<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span>toLowerCase<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span>toSnakeCase<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/4dd7c9a/src/validation/transformers/transformer.ts#L56">src/validation/transformers/transformer.ts:56</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/validation/transformers/transformer.ts#L56">src/validation/transformers/transformer.ts:56</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">