@coveo/push-api-client 2.5.24 → 2.5.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/style.css +34 -2
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +9 -7
- package/dist/docs/classes/CatalogSource.html +27 -21
- package/dist/docs/classes/DocumentBuilder.html +36 -32
- package/dist/docs/classes/FieldAnalyser.html +17 -15
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +10 -8
- package/dist/docs/classes/PushSource.html +35 -29
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +10 -8
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +10 -8
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +8 -6
- package/dist/docs/classes/errors.InvalidDocument.html +8 -6
- package/dist/docs/classes/errors.InvalidPermanentId.html +8 -6
- package/dist/docs/classes/errors.NotAFileError.html +8 -6
- package/dist/docs/classes/errors.NotAJsonFileError.html +8 -6
- package/dist/docs/classes/errors.PrivilegeError.html +9 -7
- package/dist/docs/classes/errors.UnsupportedAttribute.html +8 -6
- package/dist/docs/classes/errors.UnsupportedFieldError.html +11 -9
- package/dist/docs/enums/PlatformEnvironment.html +10 -8
- package/dist/docs/enums/Region.html +5 -3
- package/dist/docs/enums/SourceVisibility.html +5 -3
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +6 -4
- package/dist/docs/index.html +5 -3
- package/dist/docs/interfaces/BatchUpdateDocuments.html +8 -6
- package/dist/docs/interfaces/Document.html +19 -17
- package/dist/docs/interfaces/SecurityIdentity.html +9 -7
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +7 -5
- package/dist/docs/interfaces/UploadBatchCallbackData.html +9 -7
- package/dist/docs/modules/errors.html +6 -4
- package/dist/docs/modules.html +5 -3
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +6 -4
- package/dist/docs/types/CompressionType.html +6 -4
- package/dist/docs/types/FailedUploadCallback.html +6 -4
- package/dist/docs/types/Metadata.html +6 -4
- package/dist/docs/types/MetadataValue.html +6 -4
- package/dist/docs/types/PlatformUrlOptions.html +6 -4
- package/dist/docs/types/SecurityIdentityType.html +6 -4
- package/dist/docs/types/SuccessfulUploadCallback.html +6 -4
- package/dist/docs/types/Transformer.html +6 -4
- package/dist/docs/variables/BuiltInTransformers.html +6 -4
- package/dist/docs/variables/Source.html +6 -4
- package/package.json +8 -8
@@ -825,6 +825,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
|
|
825
825
|
padding-left: 5.5rem;
|
826
826
|
}
|
827
827
|
|
828
|
+
#tsd-sidebar-links a {
|
829
|
+
margin-top: 0;
|
830
|
+
margin-bottom: 0.5rem;
|
831
|
+
line-height: 1.25rem;
|
832
|
+
}
|
833
|
+
#tsd-sidebar-links a:last-of-type {
|
834
|
+
margin-bottom: 0;
|
835
|
+
}
|
836
|
+
|
828
837
|
a.tsd-index-link {
|
829
838
|
margin: 0.25rem 0;
|
830
839
|
font-size: 1rem;
|
@@ -978,7 +987,8 @@ a.tsd-index-link {
|
|
978
987
|
right: -40px;
|
979
988
|
}
|
980
989
|
#tsd-search .field input,
|
981
|
-
#tsd-search .title
|
990
|
+
#tsd-search .title,
|
991
|
+
#tsd-toolbar-links a {
|
982
992
|
transition: opacity 0.2s;
|
983
993
|
}
|
984
994
|
#tsd-search .results {
|
@@ -1022,7 +1032,8 @@ a.tsd-index-link {
|
|
1022
1032
|
top: 0;
|
1023
1033
|
opacity: 1;
|
1024
1034
|
}
|
1025
|
-
#tsd-search.has-focus .title
|
1035
|
+
#tsd-search.has-focus .title,
|
1036
|
+
#tsd-search.has-focus #tsd-toolbar-links a {
|
1026
1037
|
z-index: 0;
|
1027
1038
|
opacity: 0;
|
1028
1039
|
}
|
@@ -1036,6 +1047,22 @@ a.tsd-index-link {
|
|
1036
1047
|
display: block;
|
1037
1048
|
}
|
1038
1049
|
|
1050
|
+
#tsd-toolbar-links {
|
1051
|
+
position: absolute;
|
1052
|
+
top: 0;
|
1053
|
+
right: 2rem;
|
1054
|
+
height: 100%;
|
1055
|
+
display: flex;
|
1056
|
+
align-items: center;
|
1057
|
+
justify-content: flex-end;
|
1058
|
+
}
|
1059
|
+
#tsd-toolbar-links a {
|
1060
|
+
margin-left: 1.5rem;
|
1061
|
+
}
|
1062
|
+
#tsd-toolbar-links a:hover {
|
1063
|
+
text-decoration: underline;
|
1064
|
+
}
|
1065
|
+
|
1039
1066
|
.tsd-signature {
|
1040
1067
|
margin: 0 0 1rem 0;
|
1041
1068
|
padding: 1rem 0.5rem;
|
@@ -1134,6 +1161,11 @@ ul.tsd-type-parameter-list h5 {
|
|
1134
1161
|
.tsd-page-toolbar .table-cell:first-child {
|
1135
1162
|
width: 100%;
|
1136
1163
|
}
|
1164
|
+
.tsd-page-toolbar .tsd-toolbar-icon {
|
1165
|
+
box-sizing: border-box;
|
1166
|
+
line-height: 0;
|
1167
|
+
padding: 12px 0;
|
1168
|
+
}
|
1137
1169
|
|
1138
1170
|
.tsd-page-toolbar--hide {
|
1139
1171
|
transform: translateY(-100%);
|
@@ -1,11 +1,13 @@
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
5
|
+
<div class="field">
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
5
7
|
<ul class="results">
|
6
8
|
<li class="state loading">Preparing search index...</li>
|
7
|
-
<li class="state failure">The search index is not available</li></ul><a href="
|
8
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
9
11
|
<div class="container container-main">
|
10
12
|
<div class="col-8 col-content">
|
11
13
|
<div class="tsd-page-title">
|
@@ -31,7 +33,7 @@
|
|
31
33
|
<ul class="tsd-hierarchy">
|
32
34
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
33
35
|
<ul>
|
34
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
36
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
|
35
37
|
<section class="tsd-panel-group tsd-index-group">
|
36
38
|
<section class="tsd-panel tsd-index-panel">
|
37
39
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -67,14 +69,14 @@
|
|
67
69
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
68
70
|
<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
71
|
<ul>
|
70
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
72
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
|
71
73
|
<section class="tsd-panel-group tsd-member-group">
|
72
74
|
<h2>Properties</h2>
|
73
75
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityIdentity" class="tsd-anchor"></a>
|
74
76
|
<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>
|
75
77
|
<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">
|
76
78
|
<ul>
|
77
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
79
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
|
78
80
|
<section class="tsd-panel-group tsd-member-group">
|
79
81
|
<h2>Methods</h2>
|
80
82
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
@@ -88,7 +90,7 @@
|
|
88
90
|
<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">
|
89
91
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
90
92
|
<ul>
|
91
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
93
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
|
92
94
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
93
95
|
<div class="tsd-navigation settings">
|
94
96
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -1,11 +1,13 @@
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
5
|
+
<div class="field">
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
5
7
|
<ul class="results">
|
6
8
|
<li class="state loading">Preparing search index...</li>
|
7
|
-
<li class="state failure">The search index is not available</li></ul><a href="
|
8
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="" class="title">@coveo/push-api-client</a></div>
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
9
11
|
<div class="container container-main">
|
10
12
|
<div class="col-8 col-content">
|
11
13
|
<div class="tsd-page-title">
|
@@ -22,7 +24,7 @@
|
|
22
24
|
<ul class="tsd-hierarchy">
|
23
25
|
<li><span class="target">CatalogSource</span></li></ul></section><aside class="tsd-sources">
|
24
26
|
<ul>
|
25
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
27
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
|
26
28
|
<section class="tsd-panel-group tsd-index-group">
|
27
29
|
<section class="tsd-panel tsd-index-panel">
|
28
30
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -79,34 +81,38 @@
|
|
79
81
|
<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>
|
80
82
|
<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">
|
81
83
|
<ul>
|
82
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
84
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
|
83
85
|
<section class="tsd-panel-group tsd-member-group">
|
84
86
|
<h2>Properties</h2>
|
85
87
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
|
86
88
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>apikey</span><a href="#apikey" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
87
|
-
<div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div
|
89
|
+
<div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
90
|
+
<div class="tsd-comment tsd-typography"><p>An apiKey capable of pushing documents and managing sources in a Coveo organization. See <a href="https://docs.coveo.com/en/1718">Manage API Keys</a>.</p>
|
91
|
+
</div><aside class="tsd-sources">
|
88
92
|
<ul>
|
89
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
93
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></section>
|
90
94
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
91
95
|
<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>
|
92
96
|
<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">
|
93
97
|
<ul>
|
94
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
98
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
|
95
99
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
|
96
100
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>organizationid</span><a href="#organizationid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
97
|
-
<div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div
|
101
|
+
<div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
102
|
+
<div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
|
103
|
+
</div><aside class="tsd-sources">
|
98
104
|
<ul>
|
99
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
105
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
|
100
106
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
101
107
|
<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>
|
102
108
|
<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">
|
103
109
|
<ul>
|
104
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
110
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
|
105
111
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
106
112
|
<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>
|
107
113
|
<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">
|
108
114
|
<ul>
|
109
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
115
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
|
110
116
|
<section class="tsd-panel-group tsd-member-group">
|
111
117
|
<h2>Accessors</h2>
|
112
118
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
@@ -116,7 +122,7 @@
|
|
116
122
|
<li class="tsd-description">
|
117
123
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
118
124
|
<ul>
|
119
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
125
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
|
120
126
|
<section class="tsd-panel-group tsd-member-group">
|
121
127
|
<h2>Methods</h2>
|
122
128
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
|
@@ -138,7 +144,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
138
144
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
139
145
|
<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">
|
140
146
|
<ul>
|
141
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
147
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
|
142
148
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
|
143
149
|
<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>
|
144
150
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -162,7 +168,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
162
168
|
<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>
|
163
169
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
164
170
|
<ul>
|
165
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
171
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
|
166
172
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
167
173
|
<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>
|
168
174
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -183,7 +189,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
183
189
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
184
190
|
<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">
|
185
191
|
<ul>
|
186
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
192
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
|
187
193
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
188
194
|
<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>
|
189
195
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -206,7 +212,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
206
212
|
<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>
|
207
213
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
208
214
|
<ul>
|
209
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
215
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
|
210
216
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
211
217
|
<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>
|
212
218
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -228,7 +234,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
228
234
|
</div></li></ul></div>
|
229
235
|
<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><br/><span> </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
230
236
|
<ul>
|
231
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
237
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
|
232
238
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
233
239
|
<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>
|
234
240
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -241,7 +247,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
241
247
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
242
248
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
|
243
249
|
<ul>
|
244
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
250
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
|
245
251
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
|
246
252
|
<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>
|
247
253
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -254,7 +260,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
254
260
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
255
261
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
|
256
262
|
<ul>
|
257
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
263
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
|
258
264
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
259
265
|
<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>
|
260
266
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -267,7 +273,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
267
273
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
268
274
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
|
269
275
|
<ul>
|
270
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
276
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
|
271
277
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
272
278
|
<div class="tsd-navigation settings">
|
273
279
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|