@coveo/push-api-client 2.5.21 → 2.5.23
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/search.js +1 -1
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +31 -17
- package/dist/docs/classes/DocumentBuilder.html +40 -33
- package/dist/docs/classes/FieldAnalyser.html +18 -11
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/PushSource.html +39 -25
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
- package/dist/docs/classes/errors.InvalidDocument.html +3 -3
- package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
- package/dist/docs/classes/errors.NotAFileError.html +3 -3
- package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
- package/dist/docs/classes/errors.PrivilegeError.html +4 -4
- package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
- package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
- package/dist/docs/enums/PlatformEnvironment.html +5 -5
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
- package/dist/docs/interfaces/BatchUpdateDocuments.html +4 -4
- package/dist/docs/interfaces/Document.html +16 -16
- package/dist/docs/interfaces/SecurityIdentity.html +4 -4
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
- package/dist/docs/interfaces/UploadBatchCallbackData.html +4 -4
- package/dist/docs/modules/errors.html +1 -1
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
- package/dist/docs/types/CompressionType.html +1 -1
- package/dist/docs/types/FailedUploadCallback.html +1 -1
- package/dist/docs/types/Metadata.html +1 -1
- package/dist/docs/types/MetadataValue.html +1 -1
- package/dist/docs/types/PlatformUrlOptions.html +2 -2
- package/dist/docs/types/SecurityIdentityType.html +1 -1
- package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
- package/dist/docs/types/Transformer.html +1 -1
- package/dist/docs/variables/BuiltInTransformers.html +2 -2
- package/dist/docs/variables/Source.html +1 -1
- package/package.json +6 -6
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
<ul class="tsd-hierarchy">
|
|
23
23
|
<li><span class="target">CatalogSource</span></li></ul></section><aside class="tsd-sources">
|
|
24
24
|
<ul>
|
|
25
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
25
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
|
|
26
26
|
<section class="tsd-panel-group tsd-index-group">
|
|
27
27
|
<section class="tsd-panel tsd-index-panel">
|
|
28
28
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -34,7 +34,9 @@
|
|
|
34
34
|
</div></section>
|
|
35
35
|
<section class="tsd-index-section">
|
|
36
36
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
37
|
-
<div class="tsd-index-list"><a href="CatalogSource.html#
|
|
37
|
+
<div class="tsd-index-list"><a href="CatalogSource.html#apikey" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>apikey</span></a>
|
|
38
|
+
<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"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>options</span></a>
|
|
39
|
+
<a href="CatalogSource.html#organizationid" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>organizationid</span></a>
|
|
38
40
|
<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
41
|
<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>
|
|
40
42
|
</div></section>
|
|
@@ -77,24 +79,34 @@
|
|
|
77
79
|
<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>
|
|
78
80
|
<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
81
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
82
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
|
|
81
83
|
<section class="tsd-panel-group tsd-member-group">
|
|
82
84
|
<h2>Properties</h2>
|
|
85
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
|
|
86
|
+
<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><aside class="tsd-sources">
|
|
88
|
+
<ul>
|
|
89
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></section>
|
|
83
90
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
|
84
91
|
<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>
|
|
85
92
|
<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">
|
|
86
93
|
<ul>
|
|
87
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
94
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
|
|
95
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
|
|
96
|
+
<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><aside class="tsd-sources">
|
|
98
|
+
<ul>
|
|
99
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
|
|
88
100
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
|
89
101
|
<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>
|
|
90
102
|
<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">
|
|
91
103
|
<ul>
|
|
92
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
|
|
93
105
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
94
106
|
<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>
|
|
95
107
|
<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">
|
|
96
108
|
<ul>
|
|
97
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
109
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
|
|
98
110
|
<section class="tsd-panel-group tsd-member-group">
|
|
99
111
|
<h2>Accessors</h2>
|
|
100
112
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
|
@@ -104,7 +116,7 @@
|
|
|
104
116
|
<li class="tsd-description">
|
|
105
117
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
|
106
118
|
<ul>
|
|
107
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
|
|
108
120
|
<section class="tsd-panel-group tsd-member-group">
|
|
109
121
|
<h2>Methods</h2>
|
|
110
122
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
|
|
@@ -126,7 +138,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
126
138
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
127
139
|
<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
140
|
<ul>
|
|
129
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
141
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
|
|
130
142
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
|
|
131
143
|
<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>
|
|
132
144
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -150,7 +162,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
150
162
|
<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>
|
|
151
163
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
152
164
|
<ul>
|
|
153
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
165
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
|
|
154
166
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
|
155
167
|
<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>
|
|
156
168
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -171,7 +183,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
171
183
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
172
184
|
<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
185
|
<ul>
|
|
174
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
186
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
|
|
175
187
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
|
176
188
|
<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>
|
|
177
189
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -194,11 +206,11 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
194
206
|
<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>
|
|
195
207
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
196
208
|
<ul>
|
|
197
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
209
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
|
|
198
210
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
|
199
211
|
<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>
|
|
200
212
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
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">
|
|
213
|
+
<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><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><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>
|
|
202
214
|
<li class="tsd-description">
|
|
203
215
|
<div class="tsd-comment tsd-typography"><p>Create a new catalog source</p>
|
|
204
216
|
|
|
@@ -214,9 +226,9 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
214
226
|
<h5>sourceVisibility: <a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a></h5>
|
|
215
227
|
<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>
|
|
216
228
|
</div></li></ul></div>
|
|
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">
|
|
229
|
+
<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">
|
|
218
230
|
<ul>
|
|
219
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
231
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
|
|
220
232
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
|
221
233
|
<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>
|
|
222
234
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -229,7 +241,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
229
241
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
230
242
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
|
|
231
243
|
<ul>
|
|
232
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
244
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
|
|
233
245
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
|
|
234
246
|
<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>
|
|
235
247
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -242,7 +254,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
242
254
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
243
255
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
|
|
244
256
|
<ul>
|
|
245
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
257
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
|
|
246
258
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
|
247
259
|
<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>
|
|
248
260
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -255,7 +267,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
255
267
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
256
268
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
|
|
257
269
|
<ul>
|
|
258
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
270
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
|
|
259
271
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
260
272
|
<div class="tsd-navigation settings">
|
|
261
273
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -283,7 +295,9 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
283
295
|
<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>
|
|
284
296
|
<ul>
|
|
285
297
|
<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>
|
|
298
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#apikey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>apikey</a></li>
|
|
286
299
|
<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>
|
|
300
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#organizationid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>organizationid</a></li>
|
|
287
301
|
<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
302
|
<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>
|
|
289
303
|
<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>
|