@coveo/push-api-client 2.4.15 → 2.4.16

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 (30) hide show
  1. package/dist/docs/classes/AnySecurityIdentityBuilder.html +1 -1
  2. package/dist/docs/classes/CatalogSource.html +3 -3
  3. package/dist/docs/classes/DocumentBuilder.html +1 -1
  4. package/dist/docs/classes/FieldAnalyser.html +3 -3
  5. package/dist/docs/classes/PushSource.html +3 -3
  6. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +1 -1
  7. package/dist/docs/classes/errors.InvalidDocument.html +1 -1
  8. package/dist/docs/classes/errors.InvalidPermanentId.html +1 -1
  9. package/dist/docs/classes/errors.NotAFileError.html +1 -1
  10. package/dist/docs/classes/errors.NotAJsonFileError.html +1 -1
  11. package/dist/docs/classes/errors.PrivilegeError.html +2 -2
  12. package/dist/docs/classes/errors.UnsupportedAttribute.html +1 -1
  13. package/dist/docs/classes/errors.UnsupportedFieldError.html +3 -3
  14. package/dist/docs/enums/PlatformEnvironment.html +4 -4
  15. package/dist/docs/interfaces/BatchUpdateDocuments.html +2 -2
  16. package/dist/docs/interfaces/Document.html +13 -13
  17. package/dist/docs/interfaces/SecurityIdentity.html +3 -3
  18. package/dist/docs/interfaces/UploadBatchCallbackData.html +3 -3
  19. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  20. package/dist/docs/types/CompressionType.html +1 -1
  21. package/dist/docs/types/FailedUploadCallback.html +1 -1
  22. package/dist/docs/types/Metadata.html +1 -1
  23. package/dist/docs/types/MetadataValue.html +1 -1
  24. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  25. package/dist/docs/types/SecurityIdentityType.html +1 -1
  26. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  27. package/dist/docs/types/Transformer.html +1 -1
  28. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  29. package/dist/docs/variables/Source.html +1 -1
  30. package/package.json +1 -1
package/dist/docs/classes/AnySecurityIdentityBuilder.html CHANGED
@@ -71,7 +71,7 @@
71
71
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>security<wbr/>Identity</span><a href="#securityIdentity" 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
72
  <div class="tsd-signature">security<wbr/>Identity<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></div><aside class="tsd-sources">
73
73
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
74
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
75
75
  <section class="tsd-panel-group tsd-member-group">
76
76
  <h2>Methods</h2>
77
77
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
package/dist/docs/classes/CatalogSource.html CHANGED
@@ -81,17 +81,17 @@
81
81
  <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>
82
82
  <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">
83
83
  <ul>
84
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
84
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
85
85
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
86
86
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <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>
87
87
  <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">
88
88
  <ul>
89
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
89
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
90
90
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="defaultOptions" class="tsd-anchor"></a>
91
91
  <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>
92
92
  <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">
93
93
  <ul>
94
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
94
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
95
95
  <section class="tsd-panel-group tsd-member-group">
96
96
  <h2>Accessors</h2>
97
97
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
package/dist/docs/classes/DocumentBuilder.html CHANGED
@@ -86,7 +86,7 @@
86
86
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>doc</span><a href="#doc" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
87
87
  <div class="tsd-signature">doc<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources">
88
88
  <ul>
89
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section></section>
89
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section></section>
90
90
  <section class="tsd-panel-group tsd-member-group">
91
91
  <h2>Methods</h2>
92
92
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
package/dist/docs/classes/FieldAnalyser.html CHANGED
@@ -64,17 +64,17 @@
64
64
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>existing<wbr/>Fields</span><a href="#existingFields" 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>
65
65
  <div class="tsd-signature">existing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section>
68
68
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="inconsistencies" class="tsd-anchor"></a>
69
69
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>inconsistencies</span><a href="#inconsistencies" 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>
70
70
  <div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
73
73
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="missingFields" class="tsd-anchor"></a>
74
74
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>missing<wbr/>Fields</span><a href="#missingFields" 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>
75
75
  <div class="tsd-signature">missing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldStore</span></div><aside class="tsd-sources">
76
76
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/fieldAnalyser/fieldAnalyser.ts#L22">src/fieldAnalyser/fieldAnalyser.ts:22</a></li></ul></aside></section></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/fieldAnalyser/fieldAnalyser.ts#L22">src/fieldAnalyser/fieldAnalyser.ts:22</a></li></ul></aside></section></section>
78
78
  <section class="tsd-panel-group tsd-member-group">
79
79
  <h2>Methods</h2>
80
80
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
package/dist/docs/classes/PushSource.html CHANGED
@@ -87,17 +87,17 @@
87
87
  <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>
88
88
  <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">
89
89
  <ul>
90
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
90
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
91
91
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
92
92
  <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>
93
93
  <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">
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
96
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="defaultOptions" class="tsd-anchor"></a>
97
97
  <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>
98
98
  <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">
99
99
  <ul>
100
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
100
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
101
101
  <section class="tsd-panel-group tsd-member-group">
102
102
  <h2>Accessors</h2>
103
103
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
package/dist/docs/classes/errors.FieldTypeInconsistencyError.html CHANGED
@@ -69,7 +69,7 @@
69
69
  <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">
70
70
  <p>Overrides PushApiClientBaseError.name</p>
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
73
73
  <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>
74
74
  <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>
75
75
  <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
@@ -71,7 +71,7 @@
71
71
  <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">
72
72
  <p>Overrides PushApiClientBaseError.name</p>
73
73
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
74
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
75
75
  <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>
76
76
  <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>
77
77
  <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.InvalidPermanentId.html CHANGED
@@ -69,7 +69,7 @@
69
69
  <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 permanentId field Error&#39;</span></div><aside class="tsd-sources">
70
70
  <p>Overrides PushApiClientBaseError.name</p>
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
73
73
  <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>
74
74
  <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>
75
75
  <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.NotAFileError.html CHANGED
@@ -69,7 +69,7 @@
69
69
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Not A File Error&#39;</span></div><aside class="tsd-sources">
70
70
  <p>Overrides PushApiClientBaseError.name</p>
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</a></li></ul></aside></section>
73
73
  <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>
74
74
  <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>
75
75
  <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.NotAJsonFileError.html CHANGED
@@ -69,7 +69,7 @@
69
69
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Not A JSON File Error&#39;</span></div><aside class="tsd-sources">
70
70
  <p>Overrides PushApiClientBaseError.name</p>
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</a></li></ul></aside></section>
73
73
  <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>
74
74
  <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>
75
75
  <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.PrivilegeError.html CHANGED
@@ -63,13 +63,13 @@
63
63
  <div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
64
64
  <p>Inherited from PushApiClientBaseError.message</p>
65
65
  <ul>
66
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
66
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
67
67
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
68
68
  <h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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>
69
69
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Privilege Error&#39;</span></div><aside class="tsd-sources">
70
70
  <p>Overrides PushApiClientBaseError.name</p>
71
71
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
72
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</a></li></ul></aside></section>
73
73
  <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>
74
74
  <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>
75
75
  <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.UnsupportedAttribute.html CHANGED
@@ -71,7 +71,7 @@
71
71
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Unsupported Attribute Error&#39;</span></div><aside class="tsd-sources">
72
72
  <p>Overrides PushApiClientBaseError.name</p>
73
73
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/validatorErrors.ts#L25">src/errors/validatorErrors.ts:25</a></li></ul></aside></section>
74
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/validatorErrors.ts#L25">src/errors/validatorErrors.ts:25</a></li></ul></aside></section>
75
75
  <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>
76
76
  <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>
77
77
  <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.UnsupportedFieldError.html CHANGED
@@ -75,7 +75,7 @@
75
75
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Unsupported field Error&#39;</span></div><aside class="tsd-sources">
76
76
  <p>Overrides PushApiClientBaseError.name</p>
77
77
  <ul>
78
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
78
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
79
79
  <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>
80
80
  <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>
81
81
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -86,12 +86,12 @@
86
86
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>unsupported<wbr/>Fields</span><a href="#unsupportedFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
87
87
  <div class="tsd-signature">unsupported<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
88
88
  <ul>
89
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
89
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
90
90
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyFieldNameReplacer" class="tsd-anchor"></a>
91
91
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>empty<wbr/>Field<wbr/>Name<wbr/>Replacer</span><a href="#emptyFieldNameReplacer" 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>
92
92
  <div class="tsd-signature">empty<wbr/>Field<wbr/>Name<wbr/>Replacer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&lt;empty field name&gt;&#39;</span></div><aside class="tsd-sources">
93
93
  <ul>
94
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
94
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
95
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
96
96
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" 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>
97
97
  <div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
package/dist/docs/enums/PlatformEnvironment.html CHANGED
@@ -31,22 +31,22 @@
31
31
  <h3 class="tsd-anchor-link"><span>Dev</span><a href="#Dev" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
32
32
  <div class="tsd-signature">Dev<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dev&quot;</span></div><aside class="tsd-sources">
33
33
  <ul>
34
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
34
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
35
35
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Hipaa" class="tsd-anchor"></a>
36
36
  <h3 class="tsd-anchor-link"><span>Hipaa</span><a href="#Hipaa" 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>
37
37
  <div class="tsd-signature">Hipaa<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;hipaa&quot;</span></div><aside class="tsd-sources">
38
38
  <ul>
39
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
39
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
40
40
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Prod" class="tsd-anchor"></a>
41
41
  <h3 class="tsd-anchor-link"><span>Prod</span><a href="#Prod" 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>
42
42
  <div class="tsd-signature">Prod<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;prod&quot;</span></div><aside class="tsd-sources">
43
43
  <ul>
44
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
44
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
45
45
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stg" class="tsd-anchor"></a>
46
46
  <h3 class="tsd-anchor-link"><span>Stg</span><a href="#Stg" 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>
47
47
  <div class="tsd-signature">Stg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stg&quot;</span></div><aside class="tsd-sources">
48
48
  <ul>
49
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
49
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
50
50
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
51
51
  <div class="tsd-navigation settings">
52
52
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/BatchUpdateDocuments.html CHANGED
@@ -33,12 +33,12 @@
33
33
  <h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update</span><a href="#addOrUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
34
34
  <div class="tsd-signature">add<wbr/>Or<wbr/>Update<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
35
35
  <ul>
36
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
36
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
37
37
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
38
38
  <h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
39
39
  <div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
40
40
  <ul>
41
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
41
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
42
42
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
43
43
  <div class="tsd-navigation settings">
44
44
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/Document.html CHANGED
@@ -49,14 +49,14 @@
49
49
  <div class="tsd-comment tsd-typography"><p>The author of the document.</p>
50
50
  </div><aside class="tsd-sources">
51
51
  <ul>
52
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L72">src/document.ts:72</a></li></ul></aside></section>
52
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L72">src/document.ts:72</a></li></ul></aside></section>
53
53
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="clickableUri" class="tsd-anchor"></a>
54
54
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>clickable<wbr/>Uri</span><a href="#clickableUri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
55
55
  <div class="tsd-signature">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
56
56
  <div class="tsd-comment tsd-typography"><p>The clickable URI associated with the document.</p>
57
57
  </div><aside class="tsd-sources">
58
58
  <ul>
59
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L68">src/document.ts:68</a></li></ul></aside></section>
59
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L68">src/document.ts:68</a></li></ul></aside></section>
60
60
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="compressedBinaryData" class="tsd-anchor"></a>
61
61
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>compressed<wbr/>Binary<wbr/>Data</span><a href="#compressedBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
62
62
  <div class="tsd-signature">compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
@@ -79,7 +79,7 @@
79
79
  <p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
80
80
  </div></li></ul></div><aside class="tsd-sources">
81
81
  <ul>
82
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L122">src/document.ts:122</a></li></ul></aside></section>
82
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L122">src/document.ts:122</a></li></ul></aside></section>
83
83
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data-1" class="tsd-anchor"></a>
84
84
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>data</span><a href="#data-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
85
85
  <div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -90,7 +90,7 @@
90
90
  <p>Example: <code>This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.</code></p>
91
91
  </div><aside class="tsd-sources">
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L110">src/document.ts:110</a></li></ul></aside></section>
93
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L110">src/document.ts:110</a></li></ul></aside></section>
94
94
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="date" class="tsd-anchor"></a>
95
95
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
96
96
  <div class="tsd-signature">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -98,7 +98,7 @@
98
98
  <p>Optional, will default to indexation date.</p>
99
99
  </div><aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L78">src/document.ts:78</a></li></ul></aside></section>
101
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L78">src/document.ts:78</a></li></ul></aside></section>
102
102
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fileExtension" class="tsd-anchor"></a>
103
103
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>file<wbr/>Extension</span><a href="#fileExtension" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
104
104
  <div class="tsd-signature">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -108,7 +108,7 @@
108
108
  <p>Example: <code>.html</code></p>
109
109
  </div><aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L176">src/document.ts:176</a></li></ul></aside></section>
111
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L176">src/document.ts:176</a></li></ul></aside></section>
112
112
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="metadata" class="tsd-anchor"></a>
113
113
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
114
114
  <div class="tsd-signature">metadata<span class="tsd-signature-symbol">?:</span> <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></div>
@@ -118,7 +118,7 @@
118
118
  <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
119
119
  </div><aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L143">src/document.ts:143</a></li></ul></aside></section>
121
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L143">src/document.ts:143</a></li></ul></aside></section>
122
122
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="modifiedDate" class="tsd-anchor"></a>
123
123
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modified<wbr/>Date</span><a href="#modifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
124
124
  <div class="tsd-signature">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -126,7 +126,7 @@
126
126
  <p>Optional, will default to indexation date.</p>
127
127
  </div><aside class="tsd-sources">
128
128
  <ul>
129
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L84">src/document.ts:84</a></li></ul></aside></section>
129
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L84">src/document.ts:84</a></li></ul></aside></section>
130
130
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parentId" class="tsd-anchor"></a>
131
131
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parent<wbr/>Id</span><a href="#parentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
132
132
  <div class="tsd-signature">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -135,7 +135,7 @@
135
135
  <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
136
136
  </div><aside class="tsd-sources">
137
137
  <ul>
138
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L98">src/document.ts:98</a></li></ul></aside></section>
138
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L98">src/document.ts:98</a></li></ul></aside></section>
139
139
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permanentId" class="tsd-anchor"></a>
140
140
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permanent<wbr/>Id</span><a href="#permanentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
141
141
  <div class="tsd-signature">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -143,7 +143,7 @@
143
143
  <p>Optional, will be derived from the document URI.</p>
144
144
  </div><aside class="tsd-sources">
145
145
  <ul>
146
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L90">src/document.ts:90</a></li></ul></aside></section>
146
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L90">src/document.ts:90</a></li></ul></aside></section>
147
147
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permissions" class="tsd-anchor"></a>
148
148
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permissions</span><a href="#permissions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
149
149
  <div class="tsd-signature">permissions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>deniedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
@@ -168,14 +168,14 @@
168
168
  <div class="tsd-comment tsd-typography"><p>The list of denied permissions for this permission set.</p>
169
169
  </div></li></ul></div><aside class="tsd-sources">
170
170
  <ul>
171
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L151">src/document.ts:151</a></li></ul></aside></section>
171
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L151">src/document.ts:151</a></li></ul></aside></section>
172
172
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a>
173
173
  <h3 class="tsd-anchor-link"><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
174
174
  <div class="tsd-signature">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
175
  <div class="tsd-comment tsd-typography"><p>The title of the document.</p>
176
176
  </div><aside class="tsd-sources">
177
177
  <ul>
178
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L64">src/document.ts:64</a></li></ul></aside></section>
178
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L64">src/document.ts:64</a></li></ul></aside></section>
179
179
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uri" class="tsd-anchor"></a>
180
180
  <h3 class="tsd-anchor-link"><span>uri</span><a href="#uri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
181
181
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -187,7 +187,7 @@
187
187
  </ul>
188
188
  </div><aside class="tsd-sources">
189
189
  <ul>
190
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L60">src/document.ts:60</a></li></ul></aside></section></section></div>
190
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L60">src/document.ts:60</a></li></ul></aside></section></section></div>
191
191
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
192
192
  <div class="tsd-navigation settings">
193
193
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentity.html CHANGED
@@ -44,7 +44,7 @@
44
44
  </ul>
45
45
  </div><aside class="tsd-sources">
46
46
  <ul>
47
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
47
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
48
48
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a>
49
49
  <h3 class="tsd-anchor-link"><span>identity<wbr/>Type</span><a href="#identityType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
50
50
  <div class="tsd-signature">identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../types/SecurityIdentityType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a></div>
@@ -58,7 +58,7 @@ Valid values:</p>
58
58
  </ul>
59
59
  </div><aside class="tsd-sources">
60
60
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
62
62
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a>
63
63
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
64
64
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -66,7 +66,7 @@ Valid values:</p>
66
66
  <p>Defaults to the first security identity provider associated with the target Push source.</p>
67
67
  </div><aside class="tsd-sources">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
70
70
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
71
71
  <div class="tsd-navigation settings">
72
72
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/UploadBatchCallbackData.html CHANGED
@@ -42,17 +42,17 @@
42
42
  <h3 class="tsd-anchor-link"><span>batch</span><a href="#batch" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
43
43
  <div class="tsd-signature">batch<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
44
44
  <ul>
45
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
45
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
46
46
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a>
47
47
  <h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
48
48
  <div class="tsd-signature">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
49
49
  <ul>
50
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
50
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
51
51
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a>
52
52
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>res</span><a href="#res" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
53
53
  <div class="tsd-signature">res<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
54
54
  <ul>
55
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
55
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
56
56
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
57
57
  <div class="tsd-navigation settings">
58
58
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/BatchUpdateDocumentsFromFiles.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias BatchUpdateDocumentsFromFiles</h1></div>
16
16
  <div class="tsd-signature">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ConcurrentProcessing</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ParseDocumentOptions</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/interfaces.ts#L64">src/interfaces.ts:64</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/interfaces.ts#L64">src/interfaces.ts:64</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/CompressionType.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <div class="tsd-comment tsd-typography"><p>The compression type that was applied to your compressed document.</p>
18
18
  </div><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L42">src/document.ts:42</a></li></ul></aside></div>
20
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L42">src/document.ts:42</a></li></ul></aside></div>
21
21
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
  <div class="tsd-navigation settings">
23
23
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/FailedUploadCallback.html CHANGED
@@ -31,7 +31,7 @@
31
31
  <h5>value: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
32
32
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
33
33
  <ul>
34
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/help/fileConsumer.ts#L14">src/help/fileConsumer.ts:14</a></li></ul></aside></div>
34
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/help/fileConsumer.ts#L14">src/help/fileConsumer.ts:14</a></li></ul></aside></div>
35
35
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
36
36
  <div class="tsd-navigation settings">
37
37
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Metadata.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias Metadata</h1></div>
16
16
  <div class="tsd-signature">Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/MetadataValue.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias MetadataValue</h1></div>
16
16
  <div class="tsd-signature">Metadata<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/PlatformUrlOptions.html CHANGED
@@ -22,7 +22,7 @@
22
22
  <li class="tsd-parameter">
23
23
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> region<span class="tsd-signature-symbol">?: </span><a href="../enums/Region.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Region</a></h5></li></ul></div><aside class="tsd-sources">
24
24
  <ul>
25
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/environment.ts#L14">src/environment.ts:14</a></li></ul></aside></div>
25
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/environment.ts#L14">src/environment.ts:14</a></li></ul></aside></div>
26
26
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
27
27
  <div class="tsd-navigation settings">
28
28
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/SecurityIdentityType.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Type alias SecurityIdentityType</h1></div>
16
16
  <div class="tsd-signature">Security<wbr/>Identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNKNOWN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;VIRTUAL_GROUP&quot;</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/SuccessfulUploadCallback.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <h5>data: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
30
30
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
31
31
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/help/fileConsumer.ts#L13">src/help/fileConsumer.ts:13</a></li></ul></aside></div>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/help/fileConsumer.ts#L13">src/help/fileConsumer.ts:13</a></li></ul></aside></div>
33
33
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
34
34
  <div class="tsd-navigation settings">
35
35
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Transformer.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
30
30
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
31
31
  <ul>
32
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/validation/transformers/transformer.ts#L1">src/validation/transformers/transformer.ts:1</a></li></ul></aside></div>
32
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/validation/transformers/transformer.ts#L1">src/validation/transformers/transformer.ts:1</a></li></ul></aside></div>
33
33
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
34
34
  <div class="tsd-navigation settings">
35
35
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/variables/BuiltInTransformers.html CHANGED
@@ -15,7 +15,7 @@
15
15
  <h1>Variable BuiltInTransformers<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
16
16
  <div class="tsd-signature">Built<wbr/>In<wbr/>Transformers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>identity<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span>toLowerCase<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span>toSnakeCase<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
17
17
  <ul>
18
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/validation/transformers/transformer.ts#L56">src/validation/transformers/transformer.ts:56</a></li></ul></aside></div>
18
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/validation/transformers/transformer.ts#L56">src/validation/transformers/transformer.ts:56</a></li></ul></aside></div>
19
19
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
20
20
  <div class="tsd-navigation settings">
21
21
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/variables/Source.html CHANGED
@@ -18,7 +18,7 @@
18
18
  <h3>Deprecated</h3><p>This class has been replaced by <a href="../classes/PushSource.html">PushSource</a></p>
19
19
  </div><aside class="tsd-sources">
20
20
  <ul>
21
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b1f2f65/src/source/source.ts#L6">src/source/source.ts:6</a></li></ul></aside></div>
21
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/source/source.ts#L6">src/source/source.ts:6</a></li></ul></aside></div>
22
22
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
23
23
  <div class="tsd-navigation settings">
24
24
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/push-api-client",
3
- "version": "2.4.15",
3
+ "version": "2.4.16",
4
4
  "description": "Push API client",
5
5
  "main": "./dist/index.js",
6
6
  "files": [