@coveo/push-api-client 2.4.16 → 2.4.26

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 (48) hide show
  1. package/dist/docs/assets/highlight.css +49 -0
  2. package/dist/docs/assets/main.js +3 -3
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/assets/style.css +6 -82
  5. package/dist/docs/classes/AnySecurityIdentityBuilder.html +16 -12
  6. package/dist/docs/classes/CatalogSource.html +68 -56
  7. package/dist/docs/classes/DocumentBuilder.html +140 -113
  8. package/dist/docs/classes/FieldAnalyser.html +60 -51
  9. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +12 -8
  10. package/dist/docs/classes/PushSource.html +97 -77
  11. package/dist/docs/classes/UserSecurityIdentityBuilder.html +12 -8
  12. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +12 -8
  13. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +14 -11
  14. package/dist/docs/classes/errors.InvalidDocument.html +14 -11
  15. package/dist/docs/classes/errors.InvalidPermanentId.html +14 -11
  16. package/dist/docs/classes/errors.NotAFileError.html +14 -11
  17. package/dist/docs/classes/errors.NotAJsonFileError.html +14 -11
  18. package/dist/docs/classes/errors.PrivilegeError.html +15 -12
  19. package/dist/docs/classes/errors.UnsupportedAttribute.html +14 -11
  20. package/dist/docs/classes/errors.UnsupportedFieldError.html +24 -20
  21. package/dist/docs/enums/PlatformEnvironment.html +8 -6
  22. package/dist/docs/enums/Region.html +4 -2
  23. package/dist/docs/enums/SourceVisibility.html +4 -2
  24. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +5 -4
  25. package/dist/docs/index.html +50 -3
  26. package/dist/docs/interfaces/BatchUpdateDocuments.html +6 -4
  27. package/dist/docs/interfaces/Document.html +17 -15
  28. package/dist/docs/interfaces/SecurityIdentity.html +7 -5
  29. package/dist/docs/interfaces/SecurityIdentityBuilder.html +8 -5
  30. package/dist/docs/interfaces/UploadBatchCallbackData.html +7 -5
  31. package/dist/docs/modules/errors.html +4 -2
  32. package/dist/docs/modules.html +1 -1
  33. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +2 -2
  34. package/dist/docs/types/CompressionType.html +2 -2
  35. package/dist/docs/types/FailedUploadCallback.html +3 -4
  36. package/dist/docs/types/Metadata.html +2 -2
  37. package/dist/docs/types/MetadataValue.html +2 -2
  38. package/dist/docs/types/PlatformUrlOptions.html +2 -2
  39. package/dist/docs/types/SecurityIdentityType.html +2 -2
  40. package/dist/docs/types/SuccessfulUploadCallback.html +3 -4
  41. package/dist/docs/types/Transformer.html +3 -4
  42. package/dist/docs/variables/BuiltInTransformers.html +2 -2
  43. package/dist/docs/variables/Source.html +2 -2
  44. package/dist/source/catalog.stream.spec.js +13 -0
  45. package/dist/source/catalog.stream.spec.js.map +1 -1
  46. package/dist/source/documentUploader.js +3 -2
  47. package/dist/source/documentUploader.js.map +1 -1
  48. package/package.json +13 -13
package/dist/docs/enums/SourceVisibility.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SourceVisibility | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SourceVisibility | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -12,7 +12,9 @@
12
12
  <ul class="tsd-breadcrumb">
13
13
  <li><a href="../modules.html">@coveo/push-api-client</a></li>
14
14
  <li><a href="SourceVisibility.html">SourceVisibility</a></li></ul>
15
- <h1>Enumeration SourceVisibility</h1></div>
15
+ <h1>Enumeration SourceVisibility</h1></div><aside class="tsd-sources">
16
+ <ul>
17
+ <li>Defined in node_modules/@coveord/platform-client/dist/definitions/resources/Enums.d.ts:144</li></ul></aside>
16
18
  <section class="tsd-panel-group tsd-index-group">
17
19
  <section class="tsd-panel tsd-index-panel">
18
20
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>parseAndGetDocumentBuilderFromJSONDocument | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>parseAndGetDocumentBuilderFromJSONDocument | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -15,8 +15,7 @@
15
15
  <h1>Function parseAndGetDocumentBuilderFromJSONDocument</h1></div>
16
16
  <section class="tsd-panel">
17
17
  <ul class="tsd-signatures tsd-kind-function">
18
- <li class="tsd-signature" id="parseAndGetDocumentBuilderFromJSONDocument">parse<wbr/>And<wbr/>Get<wbr/>Document<wbr/>Builder<wbr/>FromJSONDocument<span class="tsd-signature-symbol">(</span>documentPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParseDocumentOptions</span><span class="tsd-signature-symbol">)</span><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></li></ul>
19
- <ul class="tsd-descriptions">
18
+ <li class="tsd-signature tsd-anchor-link" id="parseAndGetDocumentBuilderFromJSONDocument">parse<wbr/>And<wbr/>Get<wbr/>Document<wbr/>Builder<wbr/>FromJSONDocument<span class="tsd-signature-symbol">(</span>documentPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParseDocumentOptions</span><span class="tsd-signature-symbol">)</span><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><a href="#parseAndGetDocumentBuilderFromJSONDocument" 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></li>
20
19
  <li class="tsd-description">
21
20
  <div class="tsd-parameters">
22
21
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -25,7 +24,9 @@
25
24
  <h5>documentPath: <span class="tsd-signature-type">PathLike</span></h5></li>
26
25
  <li>
27
26
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
28
- <h4 class="tsd-returns-title">Returns <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
27
+ <h4 class="tsd-returns-title">Returns <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
28
+ <ul>
29
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
29
30
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
30
31
  <div class="tsd-navigation settings">
31
32
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/index.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base=".">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -11,9 +11,56 @@
11
11
  <div class="tsd-page-title">
12
12
  <h2>@coveo/push-api-client</h2></div>
13
13
  <div class="tsd-panel tsd-typography">
14
- <a href="#" id="" style="color: inherit; text-decoration: none;">
15
- <h1></h1>
14
+ <a href="#coveopush-api-clientjs" id="coveopush-api-clientjs" style="color: inherit; text-decoration: none;">
15
+ <h1>@coveo/push-api-client.js</h1>
16
16
  </a>
17
+ <p>Coveo Push API client</p>
18
+
19
+ <a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
20
+ <h2>Installation</h2>
21
+ </a>
22
+ <p><code>npm i @coveo/push-api-client</code></p>
23
+
24
+ <a href="#features" id="features" style="color: inherit; text-decoration: none;">
25
+ <h2>Features</h2>
26
+ </a>
27
+ <ul>
28
+ <li>Upload data to both Push and Catalog sources</li>
29
+ <li>Pre-push document validation</li>
30
+ <li>Automatic custom field creation</li>
31
+ <li>Full catalog upload and incremental document update</li>
32
+ <li>Optimized for large payload uploads</li>
33
+ </ul>
34
+
35
+ <a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
36
+ <h2>Usage</h2>
37
+ </a>
38
+ <pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> {</span><span class="hl-2">PushSource</span><span class="hl-1">, </span><span class="hl-2">DocumentBuilder</span><span class="hl-1">} </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@coveo/push-api-client&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">PushSource</span><span class="hl-1">(</span><span class="hl-3">&#39;my_api_key&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;my_coveo_organization_id&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">myDocument</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">DocumentBuilder</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-3">&#39;https://my.document.uri&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">&#39;My document title&#39;</span><br/><span class="hl-1"> ).</span><span class="hl-5">withData</span><span class="hl-1">(</span><span class="hl-3">&#39;these words will be searchable&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">source</span><span class="hl-1">.</span><span class="hl-5">addOrUpdateDocument</span><span class="hl-1">(</span><span class="hl-3">&#39;my_source_id&#39;</span><span class="hl-1">, </span><span class="hl-2">myDocument</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">main</span><span class="hl-1">();</span>
39
+ </code></pre>
40
+ <p>You can also upload your data into a catalog source</p>
41
+ <pre><code class="language-js"><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">CatalogSource</span><span class="hl-1">(</span><span class="hl-3">&#39;my_api_key&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;my_coveo_organization_id&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">source</span><br/><span class="hl-1"> .</span><span class="hl-5">batchStreamDocumentsFromFiles</span><span class="hl-1">(</span><span class="hl-3">&#39;my_source_id&#39;</span><span class="hl-1">, [</span><span class="hl-3">&#39;path/to/file_or_folder&#39;</span><span class="hl-1">])</span><br/><span class="hl-1"> .</span><span class="hl-5">batch</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">main</span><span class="hl-1">();</span><br/>
42
+ </code></pre>
43
+ <p>See more examples in the <code>./samples</code> folder.</p>
44
+
45
+ <a href="#local-development" id="local-development" style="color: inherit; text-decoration: none;">
46
+ <h2>Local development</h2>
47
+ </a>
48
+ <ul>
49
+ <li><code>npm i</code></li>
50
+ <li>Copy <code>env.sample</code> to <code>.env</code>, and replace the variables with proper values.</li>
51
+ <li><code>npm run dev</code> to compile and run <code>./src/localtest.ts</code>.</li>
52
+ <li><code>npm run test</code> for unit tests.</li>
53
+ </ul>
54
+
55
+ <a href="#commit" id="commit" style="color: inherit; text-decoration: none;">
56
+ <h2>Commit</h2>
57
+ </a>
58
+ <p>Use <code>npm run commit</code> to get a properly formatted commit message which will help control the versioning and CHANGELOG generation.</p>
59
+
60
+ <a href="#release" id="release" style="color: inherit; text-decoration: none;">
61
+ <h2>Release</h2>
62
+ </a>
63
+ <p>Run Github action named <code>release</code>, which will bump version, tag and publish to npm.</p>
17
64
  </div></div>
18
65
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
19
66
  <div class="tsd-navigation settings">
package/dist/docs/interfaces/BatchUpdateDocuments.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchUpdateDocuments | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchUpdateDocuments | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -16,7 +16,9 @@
16
16
  <section class="tsd-panel tsd-hierarchy">
17
17
  <h4>Hierarchy</h4>
18
18
  <ul class="tsd-hierarchy">
19
- <li><span class="target">BatchUpdateDocuments</span></li></ul></section>
19
+ <li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
20
+ <ul>
21
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
20
22
  <section class="tsd-panel-group tsd-index-group">
21
23
  <section class="tsd-panel tsd-index-panel">
22
24
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,12 +35,12 @@
33
35
  <h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update</span><a href="#addOrUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
34
36
  <div class="tsd-signature">add<wbr/>Or<wbr/>Update<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
35
37
  <ul>
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>
38
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
37
39
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
38
40
  <h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
39
41
  <div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
40
42
  <ul>
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>
43
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
42
44
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
43
45
  <div class="tsd-navigation settings">
44
46
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/Document.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Document | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Document | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -19,7 +19,9 @@
19
19
  <section class="tsd-panel tsd-hierarchy">
20
20
  <h4>Hierarchy</h4>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">Document</span></li></ul></section>
22
+ <li><span class="target">Document</span></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L52">src/document.ts:52</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -49,14 +51,14 @@
49
51
  <div class="tsd-comment tsd-typography"><p>The author of the document.</p>
50
52
  </div><aside class="tsd-sources">
51
53
  <ul>
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>
54
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L72">src/document.ts:72</a></li></ul></aside></section>
53
55
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="clickableUri" class="tsd-anchor"></a>
54
56
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>clickable<wbr/>Uri</span><a href="#clickableUri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
55
57
  <div class="tsd-signature">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
56
58
  <div class="tsd-comment tsd-typography"><p>The clickable URI associated with the document.</p>
57
59
  </div><aside class="tsd-sources">
58
60
  <ul>
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>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L68">src/document.ts:68</a></li></ul></aside></section>
60
62
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="compressedBinaryData" class="tsd-anchor"></a>
61
63
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>compressed<wbr/>Binary<wbr/>Data</span><a href="#compressedBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
62
64
  <div class="tsd-signature">compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
@@ -79,7 +81,7 @@
79
81
  <p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
80
82
  </div></li></ul></div><aside class="tsd-sources">
81
83
  <ul>
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>
84
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L122">src/document.ts:122</a></li></ul></aside></section>
83
85
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data-1" class="tsd-anchor"></a>
84
86
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>data</span><a href="#data-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
85
87
  <div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -90,7 +92,7 @@
90
92
  <p>Example: <code>This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.</code></p>
91
93
  </div><aside class="tsd-sources">
92
94
  <ul>
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>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L110">src/document.ts:110</a></li></ul></aside></section>
94
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="date" class="tsd-anchor"></a>
95
97
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
96
98
  <div class="tsd-signature">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -98,7 +100,7 @@
98
100
  <p>Optional, will default to indexation date.</p>
99
101
  </div><aside class="tsd-sources">
100
102
  <ul>
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>
103
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L78">src/document.ts:78</a></li></ul></aside></section>
102
104
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fileExtension" class="tsd-anchor"></a>
103
105
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>file<wbr/>Extension</span><a href="#fileExtension" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
104
106
  <div class="tsd-signature">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -108,7 +110,7 @@
108
110
  <p>Example: <code>.html</code></p>
109
111
  </div><aside class="tsd-sources">
110
112
  <ul>
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>
113
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L176">src/document.ts:176</a></li></ul></aside></section>
112
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="metadata" class="tsd-anchor"></a>
113
115
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
114
116
  <div class="tsd-signature">metadata<span class="tsd-signature-symbol">?:</span> <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></div>
@@ -118,7 +120,7 @@
118
120
  <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
119
121
  </div><aside class="tsd-sources">
120
122
  <ul>
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>
123
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L143">src/document.ts:143</a></li></ul></aside></section>
122
124
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="modifiedDate" class="tsd-anchor"></a>
123
125
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modified<wbr/>Date</span><a href="#modifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
124
126
  <div class="tsd-signature">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -126,7 +128,7 @@
126
128
  <p>Optional, will default to indexation date.</p>
127
129
  </div><aside class="tsd-sources">
128
130
  <ul>
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>
131
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L84">src/document.ts:84</a></li></ul></aside></section>
130
132
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parentId" class="tsd-anchor"></a>
131
133
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parent<wbr/>Id</span><a href="#parentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
132
134
  <div class="tsd-signature">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -135,7 +137,7 @@
135
137
  <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
136
138
  </div><aside class="tsd-sources">
137
139
  <ul>
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>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L98">src/document.ts:98</a></li></ul></aside></section>
139
141
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permanentId" class="tsd-anchor"></a>
140
142
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permanent<wbr/>Id</span><a href="#permanentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
141
143
  <div class="tsd-signature">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -143,7 +145,7 @@
143
145
  <p>Optional, will be derived from the document URI.</p>
144
146
  </div><aside class="tsd-sources">
145
147
  <ul>
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>
148
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L90">src/document.ts:90</a></li></ul></aside></section>
147
149
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permissions" class="tsd-anchor"></a>
148
150
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permissions</span><a href="#permissions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
149
151
  <div class="tsd-signature">permissions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>deniedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
@@ -168,14 +170,14 @@
168
170
  <div class="tsd-comment tsd-typography"><p>The list of denied permissions for this permission set.</p>
169
171
  </div></li></ul></div><aside class="tsd-sources">
170
172
  <ul>
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>
173
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L151">src/document.ts:151</a></li></ul></aside></section>
172
174
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a>
173
175
  <h3 class="tsd-anchor-link"><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
174
176
  <div class="tsd-signature">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
177
  <div class="tsd-comment tsd-typography"><p>The title of the document.</p>
176
178
  </div><aside class="tsd-sources">
177
179
  <ul>
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>
180
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L64">src/document.ts:64</a></li></ul></aside></section>
179
181
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uri" class="tsd-anchor"></a>
180
182
  <h3 class="tsd-anchor-link"><span>uri</span><a href="#uri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
181
183
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -187,7 +189,7 @@
187
189
  </ul>
188
190
  </div><aside class="tsd-sources">
189
191
  <ul>
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>
192
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L60">src/document.ts:60</a></li></ul></aside></section></section></div>
191
193
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
192
194
  <div class="tsd-navigation settings">
193
195
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentity.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityIdentity | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityIdentity | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -19,7 +19,9 @@
19
19
  <section class="tsd-panel tsd-hierarchy">
20
20
  <h4>Hierarchy</h4>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">SecurityIdentity</span></li></ul></section>
22
+ <li><span class="target">SecurityIdentity</span></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -44,7 +46,7 @@
44
46
  </ul>
45
47
  </div><aside class="tsd-sources">
46
48
  <ul>
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>
49
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
48
50
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a>
49
51
  <h3 class="tsd-anchor-link"><span>identity<wbr/>Type</span><a href="#identityType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
50
52
  <div class="tsd-signature">identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../types/SecurityIdentityType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a></div>
@@ -58,7 +60,7 @@ Valid values:</p>
58
60
  </ul>
59
61
  </div><aside class="tsd-sources">
60
62
  <ul>
61
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/7756fa6/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
62
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a>
63
65
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
64
66
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -66,7 +68,7 @@ Valid values:</p>
66
68
  <p>Defaults to the first security identity provider associated with the target Push source.</p>
67
69
  </div><aside class="tsd-sources">
68
70
  <ul>
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>
71
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
70
72
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
71
73
  <div class="tsd-navigation settings">
72
74
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentityBuilder.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityIdentityBuilder | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityIdentityBuilder | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -26,7 +26,9 @@
26
26
  <li><a href="../classes/AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></li>
27
27
  <li><a href="../classes/GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></li>
28
28
  <li><a href="../classes/UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li>
29
- <li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section>
29
+ <li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
30
+ <ul>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
30
32
  <section class="tsd-panel-group tsd-index-group">
31
33
  <section class="tsd-panel tsd-index-panel">
32
34
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -41,10 +43,11 @@
41
43
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="build" class="tsd-anchor"></a>
42
44
  <h3 class="tsd-anchor-link"><span>build</span><a href="#build" 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
45
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
44
- <li class="tsd-signature" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></li></ul>
45
- <ul class="tsd-descriptions">
46
+ <li class="tsd-signature tsd-anchor-link" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><a href="#build.build-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>
46
47
  <li class="tsd-description">
47
- <h4 class="tsd-returns-title">Returns <a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section></div>
48
+ <h4 class="tsd-returns-title">Returns <a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
49
+ <ul>
50
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
48
51
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
49
52
  <div class="tsd-navigation settings">
50
53
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/UploadBatchCallbackData.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UploadBatchCallbackData | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UploadBatchCallbackData | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -24,7 +24,9 @@
24
24
  <section class="tsd-panel tsd-hierarchy">
25
25
  <h4>Hierarchy</h4>
26
26
  <ul class="tsd-hierarchy">
27
- <li><span class="target">UploadBatchCallbackData</span></li></ul></section>
27
+ <li><span class="target">UploadBatchCallbackData</span></li></ul></section><aside class="tsd-sources">
28
+ <ul>
29
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L20">src/interfaces.ts:20</a></li></ul></aside>
28
30
  <section class="tsd-panel-group tsd-index-group">
29
31
  <section class="tsd-panel tsd-index-panel">
30
32
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -42,17 +44,17 @@
42
44
  <h3 class="tsd-anchor-link"><span>batch</span><a href="#batch" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
43
45
  <div class="tsd-signature">batch<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
44
46
  <ul>
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>
47
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L22">src/interfaces.ts:22</a></li></ul></aside></section>
46
48
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a>
47
49
  <h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
48
50
  <div class="tsd-signature">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
49
51
  <ul>
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>
52
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L21">src/interfaces.ts:21</a></li></ul></aside></section>
51
53
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a>
52
54
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>res</span><a href="#res" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
53
55
  <div class="tsd-signature">res<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
54
56
  <ul>
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>
57
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/interfaces.ts#L23">src/interfaces.ts:23</a></li></ul></aside></section></section></div>
56
58
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
57
59
  <div class="tsd-navigation settings">
58
60
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/modules/errors.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>errors | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>errors | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -12,7 +12,9 @@
12
12
  <ul class="tsd-breadcrumb">
13
13
  <li><a href="../modules.html">@coveo/push-api-client</a></li>
14
14
  <li><a href="errors.html">errors</a></li></ul>
15
- <h1>Namespace errors</h1></div>
15
+ <h1>Namespace errors</h1></div><aside class="tsd-sources">
16
+ <ul>
17
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
16
18
  <section class="tsd-panel-group tsd-index-group">
17
19
  <section class="tsd-panel tsd-index-panel">
18
20
  <h3 class="tsd-index-heading uppercase">Index</h3>
package/dist/docs/modules.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base=".">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
package/dist/docs/types/BatchUpdateDocumentsFromFiles.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchUpdateDocumentsFromFiles | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchUpdateDocumentsFromFiles | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -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/7756fa6/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/6755192/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">