@coveo/push-api-client 2.5.23 → 2.5.25

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 (41) hide show
  1. package/dist/docs/assets/style.css +34 -2
  2. package/dist/docs/classes/AnySecurityIdentityBuilder.html +9 -7
  3. package/dist/docs/classes/CatalogSource.html +27 -21
  4. package/dist/docs/classes/DocumentBuilder.html +36 -32
  5. package/dist/docs/classes/FieldAnalyser.html +17 -15
  6. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +10 -8
  7. package/dist/docs/classes/PushSource.html +35 -29
  8. package/dist/docs/classes/UserSecurityIdentityBuilder.html +10 -8
  9. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +10 -8
  10. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +8 -6
  11. package/dist/docs/classes/errors.InvalidDocument.html +8 -6
  12. package/dist/docs/classes/errors.InvalidPermanentId.html +8 -6
  13. package/dist/docs/classes/errors.NotAFileError.html +8 -6
  14. package/dist/docs/classes/errors.NotAJsonFileError.html +8 -6
  15. package/dist/docs/classes/errors.PrivilegeError.html +9 -7
  16. package/dist/docs/classes/errors.UnsupportedAttribute.html +8 -6
  17. package/dist/docs/classes/errors.UnsupportedFieldError.html +11 -9
  18. package/dist/docs/enums/PlatformEnvironment.html +10 -8
  19. package/dist/docs/enums/Region.html +5 -3
  20. package/dist/docs/enums/SourceVisibility.html +5 -3
  21. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +6 -4
  22. package/dist/docs/index.html +5 -3
  23. package/dist/docs/interfaces/BatchUpdateDocuments.html +8 -6
  24. package/dist/docs/interfaces/Document.html +19 -17
  25. package/dist/docs/interfaces/SecurityIdentity.html +9 -7
  26. package/dist/docs/interfaces/SecurityIdentityBuilder.html +7 -5
  27. package/dist/docs/interfaces/UploadBatchCallbackData.html +9 -7
  28. package/dist/docs/modules/errors.html +6 -4
  29. package/dist/docs/modules.html +5 -3
  30. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +6 -4
  31. package/dist/docs/types/CompressionType.html +6 -4
  32. package/dist/docs/types/FailedUploadCallback.html +6 -4
  33. package/dist/docs/types/Metadata.html +6 -4
  34. package/dist/docs/types/MetadataValue.html +6 -4
  35. package/dist/docs/types/PlatformUrlOptions.html +6 -4
  36. package/dist/docs/types/SecurityIdentityType.html +6 -4
  37. package/dist/docs/types/SuccessfulUploadCallback.html +6 -4
  38. package/dist/docs/types/Transformer.html +6 -4
  39. package/dist/docs/variables/BuiltInTransformers.html +6 -4
  40. package/dist/docs/variables/Source.html +6 -4
  41. package/package.json +8 -8
package/dist/docs/enums/Region.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Region | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
package/dist/docs/enums/SourceVisibility.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SourceVisibility | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>parseAndGetDocumentBuilderFromJSONDocument | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -26,7 +28,7 @@
26
28
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
27
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
28
30
  <ul>
29
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
30
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
31
33
  <div class="tsd-navigation settings">
32
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/index.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base=".">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
package/dist/docs/interfaces/BatchUpdateDocuments.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchUpdateDocuments | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -18,7 +20,7 @@
18
20
  <ul class="tsd-hierarchy">
19
21
  <li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
20
22
  <ul>
21
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
22
24
  <section class="tsd-panel-group tsd-index-group">
23
25
  <section class="tsd-panel tsd-index-panel">
24
26
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,12 +37,12 @@
35
37
  <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
38
  <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
39
  <ul>
38
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
40
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
39
41
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
40
42
  <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
43
  <div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
42
44
  <ul>
43
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
45
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
44
46
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
45
47
  <div class="tsd-navigation settings">
46
48
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/Document.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Document | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -21,7 +23,7 @@
21
23
  <ul class="tsd-hierarchy">
22
24
  <li><span class="target">Document</span></li></ul></section><aside class="tsd-sources">
23
25
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L54">src/document.ts:54</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L54">src/document.ts:54</a></li></ul></aside>
25
27
  <section class="tsd-panel-group tsd-index-group">
26
28
  <section class="tsd-panel tsd-index-panel">
27
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -51,14 +53,14 @@
51
53
  <div class="tsd-comment tsd-typography"><p>The author of the document.</p>
52
54
  </div><aside class="tsd-sources">
53
55
  <ul>
54
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L74">src/document.ts:74</a></li></ul></aside></section>
56
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L74">src/document.ts:74</a></li></ul></aside></section>
55
57
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="clickableUri" class="tsd-anchor"></a>
56
58
  <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
59
  <div class="tsd-signature">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
58
60
  <div class="tsd-comment tsd-typography"><p>The clickable URI associated with the document.</p>
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/e2f617b/src/document.ts#L70">src/document.ts:70</a></li></ul></aside></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L70">src/document.ts:70</a></li></ul></aside></section>
62
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="compressedBinaryData" class="tsd-anchor"></a>
63
65
  <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
66
  <div class="tsd-signature">compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -81,7 +83,7 @@
81
83
  <p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
82
84
  </div></li></ul></div><aside class="tsd-sources">
83
85
  <ul>
84
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L124">src/document.ts:124</a></li></ul></aside></section>
86
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L124">src/document.ts:124</a></li></ul></aside></section>
85
87
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data-1" class="tsd-anchor"></a>
86
88
  <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
89
  <div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -92,7 +94,7 @@
92
94
  <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
95
  </div><aside class="tsd-sources">
94
96
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L112">src/document.ts:112</a></li></ul></aside></section>
97
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L112">src/document.ts:112</a></li></ul></aside></section>
96
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="date" class="tsd-anchor"></a>
97
99
  <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
100
  <div class="tsd-signature">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -100,7 +102,7 @@
100
102
  <p>Optional, will default to indexation date.</p>
101
103
  </div><aside class="tsd-sources">
102
104
  <ul>
103
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L80">src/document.ts:80</a></li></ul></aside></section>
105
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L80">src/document.ts:80</a></li></ul></aside></section>
104
106
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fileExtension" class="tsd-anchor"></a>
105
107
  <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
108
  <div class="tsd-signature">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -110,7 +112,7 @@
110
112
  <p>Example: <code>.html</code></p>
111
113
  </div><aside class="tsd-sources">
112
114
  <ul>
113
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L178">src/document.ts:178</a></li></ul></aside></section>
115
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L178">src/document.ts:178</a></li></ul></aside></section>
114
116
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="metadata" class="tsd-anchor"></a>
115
117
  <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
118
  <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 +122,7 @@
120
122
  <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
121
123
  </div><aside class="tsd-sources">
122
124
  <ul>
123
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L145">src/document.ts:145</a></li></ul></aside></section>
125
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L145">src/document.ts:145</a></li></ul></aside></section>
124
126
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="modifiedDate" class="tsd-anchor"></a>
125
127
  <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
128
  <div class="tsd-signature">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -128,7 +130,7 @@
128
130
  <p>Optional, will default to indexation date.</p>
129
131
  </div><aside class="tsd-sources">
130
132
  <ul>
131
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L86">src/document.ts:86</a></li></ul></aside></section>
133
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L86">src/document.ts:86</a></li></ul></aside></section>
132
134
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parentId" class="tsd-anchor"></a>
133
135
  <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
136
  <div class="tsd-signature">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -137,7 +139,7 @@
137
139
  <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
138
140
  </div><aside class="tsd-sources">
139
141
  <ul>
140
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L100">src/document.ts:100</a></li></ul></aside></section>
142
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L100">src/document.ts:100</a></li></ul></aside></section>
141
143
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permanentId" class="tsd-anchor"></a>
142
144
  <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
145
  <div class="tsd-signature">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -145,7 +147,7 @@
145
147
  <p>Optional, will be derived from the document URI.</p>
146
148
  </div><aside class="tsd-sources">
147
149
  <ul>
148
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L92">src/document.ts:92</a></li></ul></aside></section>
150
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L92">src/document.ts:92</a></li></ul></aside></section>
149
151
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permissions" class="tsd-anchor"></a>
150
152
  <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
153
  <div class="tsd-signature">permissions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>allowedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>deniedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -170,14 +172,14 @@
170
172
  <div class="tsd-comment tsd-typography"><p>The list of denied permissions for this permission set.</p>
171
173
  </div></li></ul></div><aside class="tsd-sources">
172
174
  <ul>
173
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L153">src/document.ts:153</a></li></ul></aside></section>
175
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L153">src/document.ts:153</a></li></ul></aside></section>
174
176
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a>
175
177
  <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
178
  <div class="tsd-signature">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
177
179
  <div class="tsd-comment tsd-typography"><p>The title of the document.</p>
178
180
  </div><aside class="tsd-sources">
179
181
  <ul>
180
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L66">src/document.ts:66</a></li></ul></aside></section>
182
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L66">src/document.ts:66</a></li></ul></aside></section>
181
183
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uri" class="tsd-anchor"></a>
182
184
  <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
185
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -189,7 +191,7 @@
189
191
  </ul>
190
192
  </div><aside class="tsd-sources">
191
193
  <ul>
192
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L62">src/document.ts:62</a></li></ul></aside></section></section></div>
194
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L62">src/document.ts:62</a></li></ul></aside></section></section></div>
193
195
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
194
196
  <div class="tsd-navigation settings">
195
197
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentity.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityIdentity | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -21,7 +23,7 @@
21
23
  <ul class="tsd-hierarchy">
22
24
  <li><span class="target">SecurityIdentity</span></li></ul></section><aside class="tsd-sources">
23
25
  <ul>
24
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
25
27
  <section class="tsd-panel-group tsd-index-group">
26
28
  <section class="tsd-panel tsd-index-panel">
27
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -46,7 +48,7 @@
46
48
  </ul>
47
49
  </div><aside class="tsd-sources">
48
50
  <ul>
49
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
51
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
50
52
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a>
51
53
  <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
54
  <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 +62,7 @@ Valid values:</p>
60
62
  </ul>
61
63
  </div><aside class="tsd-sources">
62
64
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
65
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
64
66
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a>
65
67
  <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
68
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -68,7 +70,7 @@ Valid values:</p>
68
70
  <p>Defaults to the first security identity provider associated with the target Push source.</p>
69
71
  </div><aside class="tsd-sources">
70
72
  <ul>
71
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
73
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
72
74
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
73
75
  <div class="tsd-navigation settings">
74
76
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentityBuilder.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityIdentityBuilder | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -28,7 +30,7 @@
28
30
  <li><a href="../classes/UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li>
29
31
  <li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
30
32
  <ul>
31
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
33
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
32
34
  <section class="tsd-panel-group tsd-index-group">
33
35
  <section class="tsd-panel tsd-index-panel">
34
36
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -47,7 +49,7 @@
47
49
  <li class="tsd-description">
48
50
  <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
51
  <ul>
50
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
52
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
51
53
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
52
54
  <div class="tsd-navigation settings">
53
55
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/UploadBatchCallbackData.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UploadBatchCallbackData | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -26,7 +28,7 @@
26
28
  <ul class="tsd-hierarchy">
27
29
  <li><span class="target">UploadBatchCallbackData</span></li></ul></section><aside class="tsd-sources">
28
30
  <ul>
29
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L20">src/interfaces.ts:20</a></li></ul></aside>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L20">src/interfaces.ts:20</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">
@@ -44,17 +46,17 @@
44
46
  <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
47
  <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
48
  <ul>
47
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
49
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
48
50
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a>
49
51
  <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
52
  <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
53
  <ul>
52
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
54
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
53
55
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a>
54
56
  <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
57
  <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
58
  <ul>
57
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
59
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
58
60
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
59
61
  <div class="tsd-navigation settings">
60
62
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/modules/errors.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>errors | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
+ <li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -14,7 +16,7 @@
14
16
  <li><a href="errors.html">errors</a></li></ul>
15
17
  <h1>Namespace errors</h1></div><aside class="tsd-sources">
16
18
  <ul>
17
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
19
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
18
20
  <section class="tsd-panel-group tsd-index-group">
19
21
  <section class="tsd-panel tsd-index-panel">
20
22
  <h3 class="tsd-index-heading uppercase">Index</h3>