@coveo/push-api-client 2.5.24 → 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/classes/GroupSecurityIdentityBuilder.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>GroupSecurityIdentityBuilder | @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">
@@ -27,7 +29,7 @@
27
29
  <ul class="tsd-hierarchy">
28
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
29
31
  <ul>
30
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
31
33
  <section class="tsd-panel-group tsd-index-group">
32
34
  <section class="tsd-panel tsd-index-panel">
33
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -64,19 +66,19 @@
64
66
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
65
67
  <h4 class="tsd-returns-title">Returns <a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
66
68
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
68
70
  <section class="tsd-panel-group tsd-member-group">
69
71
  <h2>Properties</h2>
70
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="group" class="tsd-anchor"></a>
71
73
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>group</span><a href="#group" 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>
72
74
  <div class="tsd-signature">group<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></div><aside class="tsd-sources">
73
75
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</a></li></ul></aside></section>
75
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
76
78
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <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>
77
79
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
78
80
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</a></li></ul></aside></section></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</a></li></ul></aside></section></section>
80
82
  <section class="tsd-panel-group tsd-member-group">
81
83
  <h2>Methods</h2>
82
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +92,7 @@
90
92
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
91
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
94
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
94
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
97
  <div class="tsd-navigation settings">
96
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/PushSource.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>PushSource | @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">
@@ -22,7 +24,7 @@
22
24
  <ul class="tsd-hierarchy">
23
25
  <li><span class="target">PushSource</span></li></ul></section><aside class="tsd-sources">
24
26
  <ul>
25
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside>
27
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside>
26
28
  <section class="tsd-panel-group tsd-index-group">
27
29
  <section class="tsd-panel tsd-index-panel">
28
30
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -85,34 +87,38 @@
85
87
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a></h5></li></ul></div>
86
88
  <h4 class="tsd-returns-title">Returns <a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a></h4><aside class="tsd-sources">
87
89
  <ul>
88
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
90
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
89
91
  <section class="tsd-panel-group tsd-member-group">
90
92
  <h2>Properties</h2>
91
93
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
92
94
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>apikey</span><a href="#apikey" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
93
- <div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
95
+ <div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
+ <div class="tsd-comment tsd-typography"><p>An apiKey capable of pushing documents and managing sources in a Coveo organization. See <a href="https://docs.coveo.com/en/1718">Manage API Keys</a>.</p>
97
+ </div><aside class="tsd-sources">
94
98
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
99
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
96
100
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
97
101
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
98
102
  <div class="tsd-signature">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
99
103
  <ul>
100
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
104
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
101
105
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
102
106
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>organizationid</span><a href="#organizationid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
103
- <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
107
+ <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
108
+ <div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
109
+ </div><aside class="tsd-sources">
104
110
  <ul>
105
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
111
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
106
112
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
107
113
  <h3 class="tsd-anchor-link"><span>platform<wbr/>Client</span><a href="#platformClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
108
114
  <div class="tsd-signature">platform<wbr/>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformClient</span></div><aside class="tsd-sources">
109
115
  <ul>
110
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
116
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
111
117
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
112
118
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>default<wbr/>Options</span><a href="#defaultOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
113
119
  <div class="tsd-signature">default<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
114
120
  <ul>
115
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
116
122
  <section class="tsd-panel-group tsd-member-group">
117
123
  <h2>Accessors</h2>
118
124
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
@@ -122,7 +128,7 @@
122
128
  <li class="tsd-description">
123
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
124
130
  <ul>
125
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
131
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
126
132
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
127
133
  <h3 class="tsd-anchor-link"><span>identity</span><a href="#identity" 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>
128
134
  <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@@ -130,7 +136,7 @@
130
136
  <li class="tsd-description">
131
137
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
132
138
  <ul>
133
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
139
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
134
140
  <section class="tsd-panel-group tsd-member-group">
135
141
  <h2>Methods</h2>
136
142
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
@@ -152,7 +158,7 @@
152
158
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
153
159
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
154
160
  <ul>
155
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
161
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
156
162
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
157
163
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents</span><a href="#batchUpdateDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
158
164
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -172,7 +178,7 @@
172
178
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
173
179
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
174
180
  <ul>
175
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
181
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
176
182
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
177
183
  <h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchUpdateDocumentsFromFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
178
184
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -195,7 +201,7 @@
195
201
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
196
202
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
197
203
  <ul>
198
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
204
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
199
205
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
200
206
  <h3 class="tsd-anchor-link"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
201
207
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -217,7 +223,7 @@
217
223
  </div></li></ul></div>
218
224
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
219
225
  <ul>
220
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
226
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
221
227
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
222
228
  <h3 class="tsd-anchor-link"><span>create<wbr/>Fields</span><a href="#createFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
223
229
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -230,7 +236,7 @@
230
236
  <h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
231
237
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
232
238
  <ul>
233
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
239
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
234
240
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
235
241
  <h3 class="tsd-anchor-link"><span>create<wbr/>Or<wbr/>Update<wbr/>Security<wbr/>Identity<wbr/>Alias</span><a href="#createOrUpdateSecurityIdentityAlias" 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>
236
242
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -249,7 +255,7 @@
249
255
  <h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
250
256
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
251
257
  <ul>
252
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
258
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
253
259
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
254
260
  <h3 class="tsd-anchor-link"><span>create<wbr/>Security<wbr/>Identity</span><a href="#createSecurityIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
255
261
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -268,7 +274,7 @@
268
274
  <h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
269
275
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
270
276
  <ul>
271
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
277
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
272
278
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
273
279
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Document</span><a href="#deleteDocument" 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>
274
280
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -288,7 +294,7 @@
288
294
  <h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
289
295
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
290
296
  <ul>
291
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
297
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
292
298
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
293
299
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Documents<wbr/>Older<wbr/>Than</span><a href="#deleteDocumentsOlderThan" 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>
294
300
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -306,7 +312,7 @@
306
312
  <h5>olderThan: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
307
313
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
308
314
  <ul>
309
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
315
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
310
316
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
311
317
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Old<wbr/>Security<wbr/>Identities</span><a href="#deleteOldSecurityIdentities" 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>
312
318
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -325,7 +331,7 @@
325
331
  <h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
326
332
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
327
333
  <ul>
328
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
334
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
329
335
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
330
336
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Security<wbr/>Identity</span><a href="#deleteSecurityIdentity" 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>
331
337
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -344,7 +350,7 @@
344
350
  <h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
345
351
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
346
352
  <ul>
347
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
353
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
348
354
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
349
355
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>file<wbr/>Container<wbr/>Strategy</span><a href="#fileContainerStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
350
356
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -357,7 +363,7 @@
357
363
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
358
364
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
359
365
  <ul>
360
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
366
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
361
367
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
362
368
  <h3 class="tsd-anchor-link"><span>manage<wbr/>Security<wbr/>Identities</span><a href="#manageSecurityIdentities" 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>
363
369
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -376,7 +382,7 @@
376
382
  <h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
377
383
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
378
384
  <ul>
379
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
385
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
380
386
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
381
387
  <h3 class="tsd-anchor-link"><span>set<wbr/>Source<wbr/>Status</span><a href="#setSourceStatus" 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>
382
388
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -394,7 +400,7 @@
394
400
  <h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
395
401
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
396
402
  <ul>
397
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
403
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
398
404
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
399
405
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>url<wbr/>Builder</span><a href="#urlBuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
400
406
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -407,7 +413,7 @@
407
413
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
408
414
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
409
415
  <ul>
410
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
416
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
411
417
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
412
418
  <div class="tsd-navigation settings">
413
419
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/UserSecurityIdentityBuilder.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>UserSecurityIdentityBuilder | @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">
@@ -27,7 +29,7 @@
27
29
  <ul class="tsd-hierarchy">
28
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
29
31
  <ul>
30
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
31
33
  <section class="tsd-panel-group tsd-index-group">
32
34
  <section class="tsd-panel tsd-index-panel">
33
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -64,19 +66,19 @@
64
66
  <h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Email Security Provider&#39;</span></h5></li></ul></div>
65
67
  <h4 class="tsd-returns-title">Returns <a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
66
68
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
68
70
  <section class="tsd-panel-group tsd-member-group">
69
71
  <h2>Properties</h2>
70
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
71
73
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</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>
72
74
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Email Security Provider&#39;</span></div><aside class="tsd-sources">
73
75
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
75
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="user" class="tsd-anchor"></a>
76
78
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
77
79
  <div class="tsd-signature">user<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></div><aside class="tsd-sources">
78
80
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
80
82
  <section class="tsd-panel-group tsd-member-group">
81
83
  <h2>Methods</h2>
82
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +92,7 @@
90
92
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
91
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
94
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
94
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
97
  <div class="tsd-navigation settings">
96
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.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>VirtualGroupSecurityIdentityBuilder | @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">
@@ -27,7 +29,7 @@
27
29
  <ul class="tsd-hierarchy">
28
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
29
31
  <ul>
30
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
31
33
  <section class="tsd-panel-group tsd-index-group">
32
34
  <section class="tsd-panel tsd-index-panel">
33
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -64,19 +66,19 @@
64
66
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
65
67
  <h4 class="tsd-returns-title">Returns <a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
66
68
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
68
70
  <section class="tsd-panel-group tsd-member-group">
69
71
  <h2>Properties</h2>
70
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
71
73
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <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>
72
74
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
73
75
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
75
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="virtualGroup" class="tsd-anchor"></a>
76
78
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>virtual<wbr/>Group</span><a href="#virtualGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
77
79
  <div class="tsd-signature">virtual<wbr/>Group<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></div><aside class="tsd-sources">
78
80
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
80
82
  <section class="tsd-panel-group tsd-member-group">
81
83
  <h2>Methods</h2>
82
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +92,7 @@
90
92
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
91
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
94
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/f1c0c05/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
94
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
97
  <div class="tsd-navigation settings">
96
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">