@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.
- package/dist/docs/assets/highlight.css +49 -0
- package/dist/docs/assets/main.js +3 -3
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/assets/style.css +6 -82
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +16 -12
- package/dist/docs/classes/CatalogSource.html +68 -56
- package/dist/docs/classes/DocumentBuilder.html +140 -113
- package/dist/docs/classes/FieldAnalyser.html +60 -51
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +12 -8
- package/dist/docs/classes/PushSource.html +97 -77
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +12 -8
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +12 -8
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +14 -11
- package/dist/docs/classes/errors.InvalidDocument.html +14 -11
- package/dist/docs/classes/errors.InvalidPermanentId.html +14 -11
- package/dist/docs/classes/errors.NotAFileError.html +14 -11
- package/dist/docs/classes/errors.NotAJsonFileError.html +14 -11
- package/dist/docs/classes/errors.PrivilegeError.html +15 -12
- package/dist/docs/classes/errors.UnsupportedAttribute.html +14 -11
- package/dist/docs/classes/errors.UnsupportedFieldError.html +24 -20
- package/dist/docs/enums/PlatformEnvironment.html +8 -6
- package/dist/docs/enums/Region.html +4 -2
- package/dist/docs/enums/SourceVisibility.html +4 -2
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +5 -4
- package/dist/docs/index.html +50 -3
- package/dist/docs/interfaces/BatchUpdateDocuments.html +6 -4
- package/dist/docs/interfaces/Document.html +17 -15
- package/dist/docs/interfaces/SecurityIdentity.html +7 -5
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +8 -5
- package/dist/docs/interfaces/UploadBatchCallbackData.html +7 -5
- package/dist/docs/modules/errors.html +4 -2
- package/dist/docs/modules.html +1 -1
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +2 -2
- package/dist/docs/types/CompressionType.html +2 -2
- package/dist/docs/types/FailedUploadCallback.html +3 -4
- package/dist/docs/types/Metadata.html +2 -2
- package/dist/docs/types/MetadataValue.html +2 -2
- package/dist/docs/types/PlatformUrlOptions.html +2 -2
- package/dist/docs/types/SecurityIdentityType.html +2 -2
- package/dist/docs/types/SuccessfulUploadCallback.html +3 -4
- package/dist/docs/types/Transformer.html +3 -4
- package/dist/docs/variables/BuiltInTransformers.html +2 -2
- package/dist/docs/variables/Source.html +2 -2
- package/dist/source/catalog.stream.spec.js +13 -0
- package/dist/source/catalog.stream.spec.js.map +1 -1
- package/dist/source/documentUploader.js +3 -2
- package/dist/source/documentUploader.js.map +1 -1
- package/package.json +13 -13
|
@@ -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>AnySecurityIdentityBuilder | @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>AnySecurityIdentityBuilder | @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>
|
|
@@ -29,7 +29,9 @@
|
|
|
29
29
|
<section class="tsd-panel">
|
|
30
30
|
<h4>Implements</h4>
|
|
31
31
|
<ul class="tsd-hierarchy">
|
|
32
|
-
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section>
|
|
32
|
+
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
|
33
|
+
<ul>
|
|
34
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
|
|
33
35
|
<section class="tsd-panel-group tsd-index-group">
|
|
34
36
|
<section class="tsd-panel tsd-index-panel">
|
|
35
37
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -41,7 +43,7 @@
|
|
|
41
43
|
</div></section>
|
|
42
44
|
<section class="tsd-index-section">
|
|
43
45
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
44
|
-
<div class="tsd-index-list"><a href="AnySecurityIdentityBuilder.html#securityIdentity" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>security<wbr/>Identity</span></a>
|
|
46
|
+
<div class="tsd-index-list"><a href="AnySecurityIdentityBuilder.html#securityIdentity" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>security<wbr/>Identity</span></a>
|
|
45
47
|
</div></section>
|
|
46
48
|
<section class="tsd-index-section">
|
|
47
49
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
@@ -52,8 +54,7 @@
|
|
|
52
54
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
|
|
53
55
|
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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>
|
|
54
56
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
55
|
-
<li class="tsd-signature" id="constructor.new_AnySecurityIdentityBuilder">new <wbr/>Any<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>identityType<span class="tsd-signature-symbol">: </span><a href="../types/SecurityIdentityType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a>, identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityProvider<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><a href="AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></li
|
|
56
|
-
<ul class="tsd-descriptions">
|
|
57
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_AnySecurityIdentityBuilder">new <wbr/>Any<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>identityType<span class="tsd-signature-symbol">: </span><a href="../types/SecurityIdentityType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a>, identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityProvider<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><a href="AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a><a href="#constructor.new_AnySecurityIdentityBuilder" 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>
|
|
57
58
|
<li class="tsd-description">
|
|
58
59
|
<div class="tsd-parameters">
|
|
59
60
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -64,27 +65,30 @@
|
|
|
64
65
|
<h5>identity: <span class="tsd-signature-type">string</span></h5></li>
|
|
65
66
|
<li>
|
|
66
67
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
67
|
-
<h4 class="tsd-returns-title">Returns <a href="AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></h4
|
|
68
|
+
<h4 class="tsd-returns-title">Returns <a href="AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
|
69
|
+
<ul>
|
|
70
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
|
|
68
71
|
<section class="tsd-panel-group tsd-member-group">
|
|
69
72
|
<h2>Properties</h2>
|
|
70
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="securityIdentity" class="tsd-anchor"></a>
|
|
73
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityIdentity" class="tsd-anchor"></a>
|
|
71
74
|
<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
75
|
<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
76
|
<ul>
|
|
74
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
77
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
|
|
75
78
|
<section class="tsd-panel-group tsd-member-group">
|
|
76
79
|
<h2>Methods</h2>
|
|
77
80
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
|
78
81
|
<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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
79
82
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
80
|
-
<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="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></li
|
|
81
|
-
<ul class="tsd-descriptions">
|
|
83
|
+
<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="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><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>
|
|
82
84
|
<li class="tsd-description">
|
|
83
85
|
<div class="tsd-comment tsd-typography"><p>Build and return the security identity.</p>
|
|
84
86
|
|
|
85
87
|
<h3>Returns</h3></div>
|
|
86
88
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></h4><aside class="tsd-sources">
|
|
87
|
-
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p
|
|
89
|
+
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
|
90
|
+
<ul>
|
|
91
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
|
|
88
92
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
89
93
|
<div class="tsd-navigation settings">
|
|
90
94
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -112,7 +116,7 @@
|
|
|
112
116
|
<li class="current tsd-kind-class"><a href="AnySecurityIdentityBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Any<wbr/>Security<wbr/>Identity<wbr/>Builder</span></a>
|
|
113
117
|
<ul>
|
|
114
118
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="AnySecurityIdentityBuilder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
|
115
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="AnySecurityIdentityBuilder.html#securityIdentity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>security<wbr/>Identity</a></li>
|
|
119
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="AnySecurityIdentityBuilder.html#securityIdentity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>security<wbr/>Identity</a></li>
|
|
116
120
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="AnySecurityIdentityBuilder.html#build" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>build</a></li></ul></li></ul></nav></div></div>
|
|
117
121
|
<div class="container tsd-generator">
|
|
118
122
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
@@ -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>CatalogSource | @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>CatalogSource | @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>
|
|
@@ -20,7 +20,9 @@
|
|
|
20
20
|
<section class="tsd-panel tsd-hierarchy">
|
|
21
21
|
<h4>Hierarchy</h4>
|
|
22
22
|
<ul class="tsd-hierarchy">
|
|
23
|
-
<li><span class="target">CatalogSource</span></li></ul></section>
|
|
23
|
+
<li><span class="target">CatalogSource</span></li></ul></section><aside class="tsd-sources">
|
|
24
|
+
<ul>
|
|
25
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
|
|
24
26
|
<section class="tsd-panel-group tsd-index-group">
|
|
25
27
|
<section class="tsd-panel tsd-index-panel">
|
|
26
28
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -32,9 +34,9 @@
|
|
|
32
34
|
</div></section>
|
|
33
35
|
<section class="tsd-index-section">
|
|
34
36
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
35
|
-
<div class="tsd-index-list"><a href="CatalogSource.html#options" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>options</span></a>
|
|
36
|
-
<a href="CatalogSource.html#platformClient" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>platform<wbr/>Client</span></a>
|
|
37
|
-
<a href="CatalogSource.html#defaultOptions" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Options</span></a>
|
|
37
|
+
<div class="tsd-index-list"><a href="CatalogSource.html#options" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>options</span></a>
|
|
38
|
+
<a href="CatalogSource.html#platformClient" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>platform<wbr/>Client</span></a>
|
|
39
|
+
<a href="CatalogSource.html#defaultOptions" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Options</span></a>
|
|
38
40
|
</div></section>
|
|
39
41
|
<section class="tsd-index-section">
|
|
40
42
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
@@ -47,17 +49,16 @@
|
|
|
47
49
|
<a href="CatalogSource.html#batchUpdateDocuments" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>batch<wbr/>Update<wbr/>Documents</span></a>
|
|
48
50
|
<a href="CatalogSource.html#batchUpdateDocumentsFromFiles" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</span></a>
|
|
49
51
|
<a href="CatalogSource.html#create" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create</span></a>
|
|
50
|
-
<a href="CatalogSource.html#fileContainerStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>file<wbr/>Container<wbr/>Strategy</span></a>
|
|
51
|
-
<a href="CatalogSource.html#streamChunkStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>stream<wbr/>Chunk<wbr/>Strategy</span></a>
|
|
52
|
-
<a href="CatalogSource.html#urlBuilder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>url<wbr/>Builder</span></a>
|
|
52
|
+
<a href="CatalogSource.html#fileContainerStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>file<wbr/>Container<wbr/>Strategy</span></a>
|
|
53
|
+
<a href="CatalogSource.html#streamChunkStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>stream<wbr/>Chunk<wbr/>Strategy</span></a>
|
|
54
|
+
<a href="CatalogSource.html#urlBuilder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>url<wbr/>Builder</span></a>
|
|
53
55
|
</div></section></div></details></section></section>
|
|
54
56
|
<section class="tsd-panel-group tsd-member-group">
|
|
55
57
|
<h2>Constructors</h2>
|
|
56
58
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
|
|
57
59
|
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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>
|
|
58
60
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
59
|
-
<li class="tsd-signature" id="constructor.new_CatalogSource">new <wbr/>Catalog<wbr/>Source<span class="tsd-signature-symbol">(</span>apikey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, organizationid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">??: </span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CatalogSource.html" class="tsd-signature-type" data-tsd-kind="Class">CatalogSource</a></li
|
|
60
|
-
<ul class="tsd-descriptions">
|
|
61
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_CatalogSource">new <wbr/>Catalog<wbr/>Source<span class="tsd-signature-symbol">(</span>apikey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, organizationid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">??: </span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CatalogSource.html" class="tsd-signature-type" data-tsd-kind="Class">CatalogSource</a><a href="#constructor.new_CatalogSource" 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>
|
|
61
62
|
<li class="tsd-description">
|
|
62
63
|
<div class="tsd-comment tsd-typography"><p>Creates an instance of CatalogSource.</p>
|
|
63
64
|
</div>
|
|
@@ -74,40 +75,42 @@
|
|
|
74
75
|
</div></li>
|
|
75
76
|
<li>
|
|
76
77
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol"> = CatalogSource.defaultOptions</span></h5></li></ul></div>
|
|
77
|
-
<h4 class="tsd-returns-title">Returns <a href="CatalogSource.html" class="tsd-signature-type" data-tsd-kind="Class">CatalogSource</a></h4
|
|
78
|
+
<h4 class="tsd-returns-title">Returns <a href="CatalogSource.html" class="tsd-signature-type" data-tsd-kind="Class">CatalogSource</a></h4><aside class="tsd-sources">
|
|
79
|
+
<ul>
|
|
80
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
|
|
78
81
|
<section class="tsd-panel-group tsd-member-group">
|
|
79
82
|
<h2>Properties</h2>
|
|
80
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="options" class="tsd-anchor"></a>
|
|
83
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
|
81
84
|
<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
85
|
<div class="tsd-signature">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
83
86
|
<ul>
|
|
84
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
85
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
|
|
87
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
|
|
88
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
|
86
89
|
<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
90
|
<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
91
|
<ul>
|
|
89
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
90
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
92
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
|
|
93
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
91
94
|
<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
95
|
<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"><</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
|
|
93
96
|
<ul>
|
|
94
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
97
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
|
|
95
98
|
<section class="tsd-panel-group tsd-member-group">
|
|
96
99
|
<h2>Accessors</h2>
|
|
97
100
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
|
98
101
|
<h3 class="tsd-anchor-link"><span>identity</span><a href="#identity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
99
102
|
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
|
|
100
|
-
<li class="tsd-signature" id="identity.identity-1"><span class="tsd-signature-symbol">get</span> identity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentity</span></li
|
|
101
|
-
<ul class="tsd-descriptions">
|
|
103
|
+
<li class="tsd-signature" id="identity.identity-1"><span class="tsd-signature-symbol">get</span> identity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentity</span></li>
|
|
102
104
|
<li class="tsd-description">
|
|
103
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4
|
|
105
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
|
106
|
+
<ul>
|
|
107
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
|
|
104
108
|
<section class="tsd-panel-group tsd-member-group">
|
|
105
109
|
<h2>Methods</h2>
|
|
106
110
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
|
|
107
111
|
<h3 class="tsd-anchor-link"><span>batch<wbr/>Stream<wbr/>Documents</span><a href="#batchStreamDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
108
112
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
109
|
-
<li class="tsd-signature" id="batchStreamDocuments.batchStreamDocuments-1">batch<wbr/>Stream<wbr/>Documents<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batch<span class="tsd-signature-symbol">: </span><a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li
|
|
110
|
-
<ul class="tsd-descriptions">
|
|
113
|
+
<li class="tsd-signature tsd-anchor-link" id="batchStreamDocuments.batchStreamDocuments-1">batch<wbr/>Stream<wbr/>Documents<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batch<span class="tsd-signature-symbol">: </span><a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#batchStreamDocuments.batchStreamDocuments-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>
|
|
111
114
|
<li class="tsd-description">
|
|
112
115
|
<div class="tsd-comment tsd-typography"><p>Send your catalog data to your catalog source.
|
|
113
116
|
See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data to Your Source</a></p>
|
|
@@ -121,12 +124,13 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
121
124
|
<h5>batch: <a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a></h5></li>
|
|
122
125
|
<li>
|
|
123
126
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
124
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4
|
|
127
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
128
|
+
<ul>
|
|
129
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
|
|
125
130
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
|
|
126
131
|
<h3 class="tsd-anchor-link"><span>batch<wbr/>Stream<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchStreamDocumentsFromFiles" 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>
|
|
127
132
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
128
|
-
<li class="tsd-signature" id="batchStreamDocumentsFromFiles.batchStreamDocumentsFromFiles-1">batch<wbr/>Stream<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filesOrDirectories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></li
|
|
129
|
-
<ul class="tsd-descriptions">
|
|
133
|
+
<li class="tsd-signature tsd-anchor-link" id="batchStreamDocumentsFromFiles.batchStreamDocumentsFromFiles-1">batch<wbr/>Stream<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filesOrDirectories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span><a href="#batchStreamDocumentsFromFiles.batchStreamDocumentsFromFiles-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>
|
|
130
134
|
<li class="tsd-description">
|
|
131
135
|
<div class="tsd-comment tsd-typography"><p>Send your catalog data to your catalog source from a list of JSON files.
|
|
132
136
|
See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data to Your Source</a></p>
|
|
@@ -144,12 +148,13 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
144
148
|
</div></li>
|
|
145
149
|
<li>
|
|
146
150
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
|
|
147
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4
|
|
151
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
152
|
+
<ul>
|
|
153
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
|
|
148
154
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
|
149
155
|
<h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents</span><a href="#batchUpdateDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
150
156
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
151
|
-
<li class="tsd-signature" id="batchUpdateDocuments.batchUpdateDocuments-1">batch<wbr/>Update<wbr/>Documents<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batch<span class="tsd-signature-symbol">: </span><a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span></li
|
|
152
|
-
<ul class="tsd-descriptions">
|
|
157
|
+
<li class="tsd-signature tsd-anchor-link" id="batchUpdateDocuments.batchUpdateDocuments-1">batch<wbr/>Update<wbr/>Documents<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batch<span class="tsd-signature-symbol">: </span><a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span><a href="#batchUpdateDocuments.batchUpdateDocuments-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>
|
|
153
158
|
<li class="tsd-description">
|
|
154
159
|
<div class="tsd-comment tsd-typography"><p>Manage batches of items in a catalog source.
|
|
155
160
|
See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
@@ -164,12 +169,13 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
164
169
|
<h5>batch: <a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a></h5></li>
|
|
165
170
|
<li>
|
|
166
171
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
167
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span></h4
|
|
172
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
173
|
+
<ul>
|
|
174
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
|
|
168
175
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
|
169
176
|
<h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchUpdateDocumentsFromFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
170
177
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
171
|
-
<li class="tsd-signature" id="batchUpdateDocumentsFromFiles.batchUpdateDocumentsFromFiles-1">batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filesOrDirectories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></li
|
|
172
|
-
<ul class="tsd-descriptions">
|
|
178
|
+
<li class="tsd-signature tsd-anchor-link" id="batchUpdateDocumentsFromFiles.batchUpdateDocumentsFromFiles-1">batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filesOrDirectories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span><a href="#batchUpdateDocumentsFromFiles.batchUpdateDocumentsFromFiles-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>
|
|
173
179
|
<li class="tsd-description">
|
|
174
180
|
<div class="tsd-comment tsd-typography"><p>Manage batches of items in a catalog source from a list of JSON files. See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update Source</a></p>
|
|
175
181
|
</div>
|
|
@@ -186,12 +192,13 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
186
192
|
</div></li>
|
|
187
193
|
<li>
|
|
188
194
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
|
|
189
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4
|
|
195
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
196
|
+
<ul>
|
|
197
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
|
|
190
198
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
|
191
199
|
<h3 class="tsd-anchor-link"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
192
200
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
193
|
-
<li class="tsd-signature" id="create.create-1">create<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sourceVisibility<span class="tsd-signature-symbol">: </span><a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<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></li
|
|
194
|
-
<ul class="tsd-descriptions">
|
|
201
|
+
<li class="tsd-signature tsd-anchor-link" id="create.create-1">create<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sourceVisibility<span class="tsd-signature-symbol">: </span><a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<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><a href="#create.create-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>
|
|
195
202
|
<li class="tsd-description">
|
|
196
203
|
<div class="tsd-comment tsd-typography"><p>Create a new catalog source</p>
|
|
197
204
|
|
|
@@ -207,43 +214,48 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
207
214
|
<h5>sourceVisibility: <a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a></h5>
|
|
208
215
|
<div class="tsd-comment tsd-typography"><p>The security option that should be applied to the content of the source. See <a href="https://docs.coveo.com/en/1779">Content Security</a>.</p>
|
|
209
216
|
</div></li></ul></div>
|
|
210
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<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></h4
|
|
211
|
-
<
|
|
217
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<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></h4><aside class="tsd-sources">
|
|
218
|
+
<ul>
|
|
219
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
|
|
220
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
|
212
221
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>file<wbr/>Container<wbr/>Strategy</span><a href="#fileContainerStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
213
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
214
|
-
<li class="tsd-signature" id="fileContainerStrategy.fileContainerStrategy-1">file<wbr/>Container<wbr/>Strategy<span class="tsd-signature-symbol">(</span>sourceId<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">FileContainerStrategy</span></li
|
|
215
|
-
<ul class="tsd-descriptions">
|
|
222
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
223
|
+
<li class="tsd-signature tsd-anchor-link" id="fileContainerStrategy.fileContainerStrategy-1">file<wbr/>Container<wbr/>Strategy<span class="tsd-signature-symbol">(</span>sourceId<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">FileContainerStrategy</span><a href="#fileContainerStrategy.fileContainerStrategy-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>
|
|
216
224
|
<li class="tsd-description">
|
|
217
225
|
<div class="tsd-parameters">
|
|
218
226
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
219
227
|
<ul class="tsd-parameter-list">
|
|
220
228
|
<li>
|
|
221
229
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
222
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4
|
|
223
|
-
<
|
|
230
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
|
|
231
|
+
<ul>
|
|
232
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
|
|
233
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
|
|
224
234
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>stream<wbr/>Chunk<wbr/>Strategy</span><a href="#streamChunkStrategy" 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>
|
|
225
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
226
|
-
<li class="tsd-signature" id="streamChunkStrategy.streamChunkStrategy-1">stream<wbr/>Chunk<wbr/>Strategy<span class="tsd-signature-symbol">(</span>sourceId<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">StreamChunkStrategy</span></li
|
|
227
|
-
<ul class="tsd-descriptions">
|
|
235
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
236
|
+
<li class="tsd-signature tsd-anchor-link" id="streamChunkStrategy.streamChunkStrategy-1">stream<wbr/>Chunk<wbr/>Strategy<span class="tsd-signature-symbol">(</span>sourceId<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">StreamChunkStrategy</span><a href="#streamChunkStrategy.streamChunkStrategy-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>
|
|
228
237
|
<li class="tsd-description">
|
|
229
238
|
<div class="tsd-parameters">
|
|
230
239
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
231
240
|
<ul class="tsd-parameter-list">
|
|
232
241
|
<li>
|
|
233
242
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
234
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4
|
|
235
|
-
<
|
|
243
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
|
|
244
|
+
<ul>
|
|
245
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
|
|
246
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
|
236
247
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>url<wbr/>Builder</span><a href="#urlBuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
237
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
238
|
-
<li class="tsd-signature" id="urlBuilder.urlBuilder-1">url<wbr/>Builder<span class="tsd-signature-symbol">(</span>sourceId<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">StreamUrlBuilder</span></li
|
|
239
|
-
<ul class="tsd-descriptions">
|
|
248
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
249
|
+
<li class="tsd-signature tsd-anchor-link" id="urlBuilder.urlBuilder-1">url<wbr/>Builder<span class="tsd-signature-symbol">(</span>sourceId<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">StreamUrlBuilder</span><a href="#urlBuilder.urlBuilder-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>
|
|
240
250
|
<li class="tsd-description">
|
|
241
251
|
<div class="tsd-parameters">
|
|
242
252
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
243
253
|
<ul class="tsd-parameter-list">
|
|
244
254
|
<li>
|
|
245
255
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
246
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4
|
|
256
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
|
|
257
|
+
<ul>
|
|
258
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
|
|
247
259
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
248
260
|
<div class="tsd-navigation settings">
|
|
249
261
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -271,18 +283,18 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
271
283
|
<li class="current tsd-kind-class"><a href="CatalogSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Catalog<wbr/>Source</span></a>
|
|
272
284
|
<ul>
|
|
273
285
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CatalogSource.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
|
274
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CatalogSource.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>options</a></li>
|
|
275
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CatalogSource.html#platformClient" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>platform<wbr/>Client</a></li>
|
|
276
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="CatalogSource.html#defaultOptions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>default<wbr/>Options</a></li>
|
|
286
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>options</a></li>
|
|
287
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#platformClient" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>platform<wbr/>Client</a></li>
|
|
288
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#defaultOptions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>default<wbr/>Options</a></li>
|
|
277
289
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="CatalogSource.html#identity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>identity</a></li>
|
|
278
290
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#batchStreamDocuments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>batch<wbr/>Stream<wbr/>Documents</a></li>
|
|
279
291
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#batchStreamDocumentsFromFiles" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>batch<wbr/>Stream<wbr/>Documents<wbr/>From<wbr/>Files</a></li>
|
|
280
292
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#batchUpdateDocuments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>batch<wbr/>Update<wbr/>Documents</a></li>
|
|
281
293
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#batchUpdateDocumentsFromFiles" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</a></li>
|
|
282
294
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#create" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create</a></li>
|
|
283
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#fileContainerStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>file<wbr/>Container<wbr/>Strategy</a></li>
|
|
284
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#streamChunkStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>stream<wbr/>Chunk<wbr/>Strategy</a></li>
|
|
285
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="CatalogSource.html#urlBuilder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>url<wbr/>Builder</a></li></ul></li></ul></nav></div></div>
|
|
295
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#fileContainerStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>file<wbr/>Container<wbr/>Strategy</a></li>
|
|
296
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#streamChunkStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>stream<wbr/>Chunk<wbr/>Strategy</a></li>
|
|
297
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#urlBuilder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>url<wbr/>Builder</a></li></ul></li></ul></nav></div></div>
|
|
286
298
|
<div class="container tsd-generator">
|
|
287
299
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
288
300
|
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|