@coveo/push-api-client 2.6.6 → 2.7.1

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 (68) hide show
  1. package/dist/APICore.js +43 -0
  2. package/dist/APICore.js.map +1 -0
  3. package/dist/definitions/APICore.d.ts +11 -0
  4. package/dist/definitions/source/catalog.d.ts +1 -0
  5. package/dist/definitions/source/documentUploader.d.ts +3 -2
  6. package/dist/definitions/source/push.d.ts +5 -5
  7. package/dist/definitions/uploadStrategy/fileContainerStrategy.d.ts +4 -4
  8. package/dist/definitions/uploadStrategy/streamChunkStrategy.d.ts +4 -4
  9. package/dist/docs/assets/search.js +1 -1
  10. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  11. package/dist/docs/classes/CatalogSource.html +24 -17
  12. package/dist/docs/classes/DocumentBuilder.html +28 -28
  13. package/dist/docs/classes/FieldAnalyser.html +12 -12
  14. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  15. package/dist/docs/classes/PushSource.html +40 -43
  16. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  17. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  18. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  19. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  20. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  21. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  22. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  23. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  24. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  25. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  26. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  27. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  28. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  29. package/dist/docs/interfaces/Document.html +14 -14
  30. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  31. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  32. package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
  33. package/dist/docs/modules/errors.html +1 -1
  34. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  35. package/dist/docs/types/CompressionType.html +1 -1
  36. package/dist/docs/types/FailedUploadCallback.html +1 -1
  37. package/dist/docs/types/Metadata.html +1 -1
  38. package/dist/docs/types/MetadataValue.html +1 -1
  39. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  40. package/dist/docs/types/SecurityIdentityType.html +1 -1
  41. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  42. package/dist/docs/types/Transformer.html +1 -1
  43. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  44. package/dist/docs/variables/Source.html +1 -1
  45. package/dist/help/fileContainer.spec.js +8 -7
  46. package/dist/help/fileContainer.spec.js.map +1 -1
  47. package/dist/source/catalog.js +4 -5
  48. package/dist/source/catalog.js.map +1 -1
  49. package/dist/source/documentUploader.js +2 -3
  50. package/dist/source/documentUploader.js.map +1 -1
  51. package/dist/source/documentUploader.spec.js +6 -19
  52. package/dist/source/documentUploader.spec.js.map +1 -1
  53. package/dist/source/push.js +7 -11
  54. package/dist/source/push.js.map +1 -1
  55. package/dist/source/push.spec.js +22 -50
  56. package/dist/source/push.spec.js.map +1 -1
  57. package/dist/uploadStrategy/fileContainerStrategy.js +4 -5
  58. package/dist/uploadStrategy/fileContainerStrategy.js.map +1 -1
  59. package/dist/uploadStrategy/fileContainerStrategy.spec.js +12 -28
  60. package/dist/uploadStrategy/fileContainerStrategy.spec.js.map +1 -1
  61. package/dist/uploadStrategy/streamChunkStrategy.js +5 -6
  62. package/dist/uploadStrategy/streamChunkStrategy.js.map +1 -1
  63. package/dist/uploadStrategy/streamChunkStrategy.spec.js +10 -34
  64. package/dist/uploadStrategy/streamChunkStrategy.spec.js.map +1 -1
  65. package/package.json +4 -3
  66. package/dist/definitions/help/axiosUtils.d.ts +0 -2
  67. package/dist/help/axiosUtils.js +0 -12
  68. package/dist/help/axiosUtils.js.map +0 -1
package/dist/docs/classes/PushSource.html CHANGED
@@ -24,7 +24,7 @@
24
24
  <ul class="tsd-hierarchy">
25
25
  <li><span class="target">PushSource</span></li></ul></section><aside class="tsd-sources">
26
26
  <ul>
27
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/source/push.ts#L48">src/source/push.ts:48</a></li></ul></aside>
28
28
  <section class="tsd-panel-group tsd-index-group">
29
29
  <section class="tsd-panel tsd-index-panel">
30
30
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,7 +36,8 @@
36
36
  </div></section>
37
37
  <section class="tsd-index-section">
38
38
  <h3 class="tsd-index-heading">Properties</h3>
39
- <div class="tsd-index-list"><a href="PushSource.html#apikey" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>apikey</span></a>
39
+ <div class="tsd-index-list"><a href="PushSource.html#api" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>api</span></a>
40
+ <a href="PushSource.html#apikey" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>apikey</span></a>
40
41
  <a href="PushSource.html#options" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>options</span></a>
41
42
  <a href="PushSource.html#organizationid" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>organizationid</span></a>
42
43
  <a href="PushSource.html#platformClient" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>platform<wbr/>Client</span></a>
@@ -44,8 +45,7 @@
44
45
  </div></section>
45
46
  <section class="tsd-index-section">
46
47
  <h3 class="tsd-index-heading">Accessors</h3>
47
- <div class="tsd-index-list"><a href="PushSource.html#documentsAxiosConfig" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>documents<wbr/>Axios<wbr/>Config</span></a>
48
- <a href="PushSource.html#identity" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>identity</span></a>
48
+ <div class="tsd-index-list"><a href="PushSource.html#identity" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>identity</span></a>
49
49
  </div></section>
50
50
  <section class="tsd-index-section">
51
51
  <h3 class="tsd-index-heading">Methods</h3>
@@ -87,48 +87,45 @@
87
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>
88
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">
89
89
  <ul>
90
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
91
91
  <section class="tsd-panel-group tsd-member-group">
92
92
  <h2>Properties</h2>
93
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="api" class="tsd-anchor"></a>
94
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>api</span><a href="#api" 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>
95
+ <div class="tsd-signature">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">APICore</span></div><aside class="tsd-sources">
96
+ <ul>
97
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
93
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
94
99
  <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>
95
100
  <div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
101
  <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
102
  </div><aside class="tsd-sources">
98
103
  <ul>
99
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
104
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
100
105
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
101
106
  <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>
102
107
  <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">
103
108
  <ul>
104
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
109
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
105
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
106
111
  <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>
107
112
  <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
108
113
  <div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
109
114
  </div><aside class="tsd-sources">
110
115
  <ul>
111
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
116
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
112
117
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
113
118
  <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>
114
119
  <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">
115
120
  <ul>
116
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside></section>
117
122
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
118
123
  <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>
119
124
  <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">
120
125
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
126
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
122
127
  <section class="tsd-panel-group tsd-member-group">
123
128
  <h2>Accessors</h2>
124
- <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
125
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>documents<wbr/>Axios<wbr/>Config</span><a href="#documentsAxiosConfig" 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
- <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-private">
127
- <li class="tsd-signature" id="documentsAxiosConfig.documentsAxiosConfig-1"><span class="tsd-signature-symbol">get</span> documentsAxiosConfig<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li>
128
- <li class="tsd-description">
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">
130
- <ul>
131
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
132
129
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
133
130
  <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>
134
131
  <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@@ -136,13 +133,13 @@
136
133
  <li class="tsd-description">
137
134
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
138
135
  <ul>
139
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
136
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L166">src/source/push.ts:166</a></li></ul></aside></li></ul></section></section>
140
137
  <section class="tsd-panel-group tsd-member-group">
141
138
  <h2>Methods</h2>
142
139
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
143
140
  <h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update<wbr/>Document</span><a href="#addOrUpdateDocument" 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>
144
141
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
145
- <li class="tsd-signature tsd-anchor-link" id="addOrUpdateDocument.addOrUpdateDocument-1">add<wbr/>Or<wbr/>Update<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, docBuilder<span class="tsd-signature-symbol">: </span><a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#addOrUpdateDocument.addOrUpdateDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
142
+ <li class="tsd-signature tsd-anchor-link" id="addOrUpdateDocument.addOrUpdateDocument-1">add<wbr/>Or<wbr/>Update<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, docBuilder<span class="tsd-signature-symbol">: </span><a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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">unknown</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><a href="#addOrUpdateDocument.addOrUpdateDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
146
143
  <li class="tsd-description">
147
144
  <div class="tsd-comment tsd-typography"><p>Adds or updates an individual item in a push source. See <a href="https://docs.coveo.com/en/133">Adding a Single Item in a Push Source</a>.</p>
148
145
 
@@ -156,9 +153,9 @@
156
153
  <h5>docBuilder: <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h5></li>
157
154
  <li>
158
155
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
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">
156
+ <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">unknown</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">
160
157
  <ul>
161
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
158
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L177">src/source/push.ts:177</a></li></ul></aside></li></ul></section>
162
159
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
163
160
  <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>
164
161
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -178,7 +175,7 @@
178
175
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
179
176
  <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">
180
177
  <ul>
181
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
178
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L198">src/source/push.ts:198</a></li></ul></aside></li></ul></section>
182
179
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
183
180
  <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>
184
181
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -201,7 +198,7 @@
201
198
  <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>
202
199
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
203
200
  <ul>
204
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
201
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L219">src/source/push.ts:219</a></li></ul></aside></li></ul></section>
205
202
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
206
203
  <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>
207
204
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -223,7 +220,7 @@
223
220
  </div></li></ul></div>
224
221
  <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">
225
222
  <ul>
226
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
223
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L82">src/source/push.ts:82</a></li></ul></aside></li></ul></section>
227
224
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
228
225
  <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>
229
226
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -236,7 +233,7 @@
236
233
  <h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
237
234
  <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">
238
235
  <ul>
239
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
236
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L280">src/source/push.ts:280</a></li></ul></aside></li></ul></section>
240
237
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
241
238
  <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>
242
239
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -255,7 +252,7 @@
255
252
  <h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
256
253
  <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">
257
254
  <ul>
258
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
255
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L111">src/source/push.ts:111</a></li></ul></aside></li></ul></section>
259
256
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
260
257
  <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>
261
258
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -274,11 +271,11 @@
274
271
  <h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
275
272
  <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">
276
273
  <ul>
277
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
274
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L96">src/source/push.ts:96</a></li></ul></aside></li></ul></section>
278
275
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
279
276
  <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>
280
277
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
281
- <li class="tsd-signature tsd-anchor-link" id="deleteDocument.deleteDocument-1">delete<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, deleteChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#deleteDocument.deleteDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
278
+ <li class="tsd-signature tsd-anchor-link" id="deleteDocument.deleteDocument-1">delete<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, deleteChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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">unknown</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><a href="#deleteDocument.deleteDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
282
279
  <li class="tsd-description">
283
280
  <div class="tsd-comment tsd-typography"><p>Deletes a specific item from a Push source. Optionally, the child items of that item can also be deleted. See <a href="https://docs.coveo.com/en/171">Deleting an Item in a Push Source</a>.</p>
284
281
 
@@ -292,13 +289,13 @@
292
289
  <h5>documentId: <span class="tsd-signature-type">string</span></h5></li>
293
290
  <li>
294
291
  <h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
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">
292
+ <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">unknown</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">
296
293
  <ul>
297
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
294
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L239">src/source/push.ts:239</a></li></ul></aside></li></ul></section>
298
295
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
299
296
  <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>
300
297
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
301
- <li class="tsd-signature tsd-anchor-link" id="deleteDocumentsOlderThan.deleteDocumentsOlderThan-1">delete<wbr/>Documents<wbr/>Older<wbr/>Than<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, olderThan<span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#deleteDocumentsOlderThan.deleteDocumentsOlderThan-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
298
+ <li class="tsd-signature tsd-anchor-link" id="deleteDocumentsOlderThan.deleteDocumentsOlderThan-1">delete<wbr/>Documents<wbr/>Older<wbr/>Than<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, olderThan<span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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">unknown</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><a href="#deleteDocumentsOlderThan.deleteDocumentsOlderThan-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
302
299
  <li class="tsd-description">
303
300
  <div class="tsd-comment tsd-typography"><p>Deletes all items whose last update was made by a Push API operation whose orderingId is strictly lower than a specified value. See <a href="https://docs.coveo.com/en/131">Deleting Old Items in a Push Source</a>.</p>
304
301
 
@@ -310,9 +307,9 @@
310
307
  <h5>sourceID: <span class="tsd-signature-type">string</span></h5></li>
311
308
  <li>
312
309
  <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>
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">
310
+ <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">unknown</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">
314
311
  <ul>
315
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
312
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L256">src/source/push.ts:256</a></li></ul></aside></li></ul></section>
316
313
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
317
314
  <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>
318
315
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -331,7 +328,7 @@
331
328
  <h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
332
329
  <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">
333
330
  <ul>
334
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
331
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L141">src/source/push.ts:141</a></li></ul></aside></li></ul></section>
335
332
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
336
333
  <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>
337
334
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -350,7 +347,7 @@
350
347
  <h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
351
348
  <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">
352
349
  <ul>
353
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
350
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L126">src/source/push.ts:126</a></li></ul></aside></li></ul></section>
354
351
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
355
352
  <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>
356
353
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -363,7 +360,7 @@
363
360
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
364
361
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
365
362
  <ul>
366
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
363
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L289">src/source/push.ts:289</a></li></ul></aside></li></ul></section>
367
364
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
368
365
  <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>
369
366
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -382,11 +379,11 @@
382
379
  <h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
383
380
  <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">
384
381
  <ul>
385
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
382
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L156">src/source/push.ts:156</a></li></ul></aside></li></ul></section>
386
383
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
387
384
  <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>
388
385
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
389
- <li class="tsd-signature tsd-anchor-link" id="setSourceStatus.setSourceStatus-1">set<wbr/>Source<wbr/>Status<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SourceStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#setSourceStatus.setSourceStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
386
+ <li class="tsd-signature tsd-anchor-link" id="setSourceStatus.setSourceStatus-1">set<wbr/>Source<wbr/>Status<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SourceStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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">unknown</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><a href="#setSourceStatus.setSourceStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
390
387
  <li class="tsd-description">
391
388
  <div class="tsd-comment tsd-typography"><p>Set the status of a push source. See <a href="https://docs.coveo.com/en/35/">Updating the Status of a Push Source</a></p>
392
389
 
@@ -398,9 +395,9 @@
398
395
  <h5>sourceID: <span class="tsd-signature-type">string</span></h5></li>
399
396
  <li>
400
397
  <h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
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">
398
+ <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">unknown</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">
402
399
  <ul>
403
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
400
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L274">src/source/push.ts:274</a></li></ul></aside></li></ul></section>
404
401
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
405
402
  <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>
406
403
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -413,7 +410,7 @@
413
410
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
414
411
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
415
412
  <ul>
416
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
413
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/source/push.ts#L285">src/source/push.ts:285</a></li></ul></aside></li></ul></section></section></div>
417
414
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
418
415
  <div class="tsd-navigation settings">
419
416
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -441,12 +438,12 @@
441
438
  <li class="current tsd-kind-class"><a href="PushSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Push<wbr/>Source</span></a>
442
439
  <ul>
443
440
  <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PushSource.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
441
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#api" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>api</a></li>
444
442
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#apikey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>apikey</a></li>
445
443
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>options</a></li>
446
444
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#organizationid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>organizationid</a></li>
447
445
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="PushSource.html#platformClient" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>platform<wbr/>Client</a></li>
448
446
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#defaultOptions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>default<wbr/>Options</a></li>
449
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#documentsAxiosConfig" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>documents<wbr/>Axios<wbr/>Config</a></li>
450
447
  <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="PushSource.html#identity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>identity</a></li>
451
448
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#addOrUpdateDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Or<wbr/>Update<wbr/>Document</a></li>
452
449
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#batchUpdateDocuments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>batch<wbr/>Update<wbr/>Documents</a></li>
package/dist/docs/classes/UserSecurityIdentityBuilder.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <ul class="tsd-hierarchy">
30
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
31
31
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
33
33
  <section class="tsd-panel-group tsd-index-group">
34
34
  <section class="tsd-panel tsd-index-panel">
35
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,19 +66,19 @@
66
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>
67
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">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
70
70
  <section class="tsd-panel-group tsd-member-group">
71
71
  <h2>Properties</h2>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
73
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>
74
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">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="user" class="tsd-anchor"></a>
78
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>
79
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">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
82
82
  <section class="tsd-panel-group tsd-member-group">
83
83
  <h2>Methods</h2>
84
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -92,7 +92,7 @@
92
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">
93
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
96
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
97
97
  <div class="tsd-navigation settings">
98
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <ul class="tsd-hierarchy">
30
30
  <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
31
31
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
33
33
  <section class="tsd-panel-group tsd-index-group">
34
34
  <section class="tsd-panel tsd-index-panel">
35
35
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,19 +66,19 @@
66
66
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
67
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">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
70
70
  <section class="tsd-panel-group tsd-member-group">
71
71
  <h2>Properties</h2>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
73
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>
74
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">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="virtualGroup" class="tsd-anchor"></a>
78
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>
79
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">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
82
82
  <section class="tsd-panel-group tsd-member-group">
83
83
  <h2>Methods</h2>
84
84
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -92,7 +92,7 @@
92
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">
93
93
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/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/3751856/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
96
96
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
97
97
  <div class="tsd-navigation settings">
98
98
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.FieldTypeInconsistencyError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">FieldTypeInconsistencyError</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -60,7 +60,7 @@
60
60
  <h4 class="tsd-returns-title">Returns <a href="errors.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</a></h4><aside class="tsd-sources">
61
61
  <p>Overrides PushApiClientBaseError.constructor</p>
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
64
64
  <section class="tsd-panel-group tsd-member-group">
65
65
  <h2>Properties</h2>
66
66
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -74,7 +74,7 @@
74
74
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Field Type Inconsistency Error&#39;</span></div><aside class="tsd-sources">
75
75
  <p>Overrides PushApiClientBaseError.name</p>
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
78
78
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
79
79
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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>
80
80
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
package/dist/docs/classes/errors.InvalidDocument.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">InvalidDocument</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/errors/validatorErrors.ts#L17">src/errors/validatorErrors.ts:17</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/errors/validatorErrors.ts#L17">src/errors/validatorErrors.ts:17</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -62,7 +62,7 @@
62
62
  <h4 class="tsd-returns-title">Returns <a href="errors.InvalidDocument.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidDocument</a></h4><aside class="tsd-sources">
63
63
  <p>Overrides PushApiClientBaseError.constructor</p>
64
64
  <ul>
65
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/errors/validatorErrors.ts#L19">src/errors/validatorErrors.ts:19</a></li></ul></aside></li></ul></section></section>
65
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/errors/validatorErrors.ts#L19">src/errors/validatorErrors.ts:19</a></li></ul></aside></li></ul></section></section>
66
66
  <section class="tsd-panel-group tsd-member-group">
67
67
  <h2>Properties</h2>
68
68
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -76,7 +76,7 @@
76
76
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Invalid JSON Document Error&#39;</span></div><aside class="tsd-sources">
77
77
  <p>Overrides PushApiClientBaseError.name</p>
78
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/206c227/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
79
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3751856/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
80
80
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
81
81
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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>
82
82
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">