@coveo/push-api-client 2.6.4 → 2.6.6
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/definitions/{source/catalog.stream.spec.d.ts → help/urlUtils.spec.d.ts} +0 -0
- package/dist/definitions/source/batchUploadDocumentsFromFile.spec.d.ts +1 -0
- package/dist/definitions/source/documentUploader.spec.d.ts +1 -0
- package/dist/definitions/uploadStrategy/fileContainerStrategy.spec.d.ts +1 -0
- package/dist/definitions/uploadStrategy/streamChunkStrategy.spec.d.ts +1 -0
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +16 -16
- package/dist/docs/classes/DocumentBuilder.html +28 -28
- package/dist/docs/classes/FieldAnalyser.html +12 -12
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/PushSource.html +24 -24
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
- 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 +3 -3
- package/dist/docs/interfaces/Document.html +14 -14
- package/dist/docs/interfaces/SecurityIdentity.html +4 -4
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
- package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
- 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 +1 -1
- 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 +1 -1
- package/dist/docs/variables/Source.html +1 -1
- package/dist/fieldAnalyser/fieldAnalyser.spec.js +0 -1
- package/dist/fieldAnalyser/fieldAnalyser.spec.js.map +1 -1
- package/dist/fieldAnalyser/fieldsUtils.spec.js +35 -3
- package/dist/fieldAnalyser/fieldsUtils.spec.js.map +1 -1
- package/dist/help/urlUtils.spec.js +42 -0
- package/dist/help/urlUtils.spec.js.map +1 -0
- package/dist/source/batchUploadDocumentsFromFile.spec.js +146 -0
- package/dist/source/batchUploadDocumentsFromFile.spec.js.map +1 -0
- package/dist/source/catalog.spec.js +20 -199
- package/dist/source/catalog.spec.js.map +1 -1
- package/dist/source/documentUploader.spec.js +132 -0
- package/dist/source/documentUploader.spec.js.map +1 -0
- package/dist/source/push.spec.js +118 -269
- package/dist/source/push.spec.js.map +1 -1
- package/dist/uploadStrategy/fileContainerStrategy.spec.js +103 -0
- package/dist/uploadStrategy/fileContainerStrategy.spec.js.map +1 -0
- package/dist/uploadStrategy/streamChunkStrategy.spec.js +106 -0
- package/dist/uploadStrategy/streamChunkStrategy.spec.js.map +1 -0
- package/package.json +1 -1
- package/dist/__stub__/largeDocuments/documentGenerator.js +0 -22
- package/dist/__stub__/largeDocuments/documentGenerator.js.map +0 -1
- package/dist/definitions/__stub__/largeDocuments/documentGenerator.d.ts +0 -12
- package/dist/source/catalog.stream.spec.js +0 -238
- package/dist/source/catalog.stream.spec.js.map +0 -1
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
<ul class="tsd-hierarchy">
|
|
34
34
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
|
35
35
|
<ul>
|
|
36
|
-
<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/206c227/src/securityIdentityBuilder.ts#L18">src/securityIdentityBuilder.ts:18</a></li></ul></aside>
|
|
37
37
|
<section class="tsd-panel-group tsd-index-group">
|
|
38
38
|
<section class="tsd-panel tsd-index-panel">
|
|
39
39
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -69,14 +69,14 @@
|
|
|
69
69
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
70
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">
|
|
71
71
|
<ul>
|
|
72
|
-
<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/206c227/src/securityIdentityBuilder.ts#L26">src/securityIdentityBuilder.ts:26</a></li></ul></aside></li></ul></section></section>
|
|
73
73
|
<section class="tsd-panel-group tsd-member-group">
|
|
74
74
|
<h2>Properties</h2>
|
|
75
75
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityIdentity" class="tsd-anchor"></a>
|
|
76
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>
|
|
77
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">
|
|
78
78
|
<ul>
|
|
79
|
-
<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/206c227/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li></ul></aside></section></section>
|
|
80
80
|
<section class="tsd-panel-group tsd-member-group">
|
|
81
81
|
<h2>Methods</h2>
|
|
82
82
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
|
@@ -90,7 +90,7 @@
|
|
|
90
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">
|
|
91
91
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
|
92
92
|
<ul>
|
|
93
|
-
<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/206c227/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li></ul></aside></li></ul></section></section></div>
|
|
94
94
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
95
95
|
<div class="tsd-navigation settings">
|
|
96
96
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
<ul class="tsd-hierarchy">
|
|
25
25
|
<li><span class="target">CatalogSource</span></li></ul></section><aside class="tsd-sources">
|
|
26
26
|
<ul>
|
|
27
|
-
<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/206c227/src/source/catalog.ts#L31">src/source/catalog.ts:31</a></li></ul></aside>
|
|
28
28
|
<section class="tsd-panel-group tsd-index-group">
|
|
29
29
|
<section class="tsd-panel tsd-index-panel">
|
|
30
30
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -81,7 +81,7 @@
|
|
|
81
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>
|
|
82
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">
|
|
83
83
|
<ul>
|
|
84
|
-
<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/206c227/src/source/catalog.ts#L45">src/source/catalog.ts:45</a></li></ul></aside></li></ul></section></section>
|
|
85
85
|
<section class="tsd-panel-group tsd-member-group">
|
|
86
86
|
<h2>Properties</h2>
|
|
87
87
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
|
|
@@ -90,29 +90,29 @@
|
|
|
90
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
91
|
</div><aside class="tsd-sources">
|
|
92
92
|
<ul>
|
|
93
|
-
<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/206c227/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></section>
|
|
94
94
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
|
95
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>
|
|
96
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">
|
|
97
97
|
<ul>
|
|
98
|
-
<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/206c227/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
|
|
99
99
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
|
|
100
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>
|
|
101
101
|
<div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
102
|
<div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
|
|
103
103
|
</div><aside class="tsd-sources">
|
|
104
104
|
<ul>
|
|
105
|
-
<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/206c227/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
|
|
106
106
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
|
107
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>
|
|
108
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">
|
|
109
109
|
<ul>
|
|
110
|
-
<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/206c227/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
|
|
111
111
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
112
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>
|
|
113
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">
|
|
114
114
|
<ul>
|
|
115
|
-
<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/206c227/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section></section>
|
|
116
116
|
<section class="tsd-panel-group tsd-member-group">
|
|
117
117
|
<h2>Accessors</h2>
|
|
118
118
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
<li class="tsd-description">
|
|
123
123
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
|
124
124
|
<ul>
|
|
125
|
-
<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/206c227/src/source/catalog.ts#L74">src/source/catalog.ts:74</a></li></ul></aside></li></ul></section></section>
|
|
126
126
|
<section class="tsd-panel-group tsd-member-group">
|
|
127
127
|
<h2>Methods</h2>
|
|
128
128
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
|
|
@@ -144,7 +144,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
144
144
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
145
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">
|
|
146
146
|
<ul>
|
|
147
|
-
<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/206c227/src/source/catalog.ts#L102">src/source/catalog.ts:102</a></li></ul></aside></li></ul></section>
|
|
148
148
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
|
|
149
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>
|
|
150
150
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -168,7 +168,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
168
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>
|
|
169
169
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
170
170
|
<ul>
|
|
171
|
-
<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/206c227/src/source/catalog.ts#L137">src/source/catalog.ts:137</a></li></ul></aside></li></ul></section>
|
|
172
172
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
|
173
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>
|
|
174
174
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -189,7 +189,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
189
189
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
190
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">
|
|
191
191
|
<ul>
|
|
192
|
-
<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/206c227/src/source/catalog.ts#L86">src/source/catalog.ts:86</a></li></ul></aside></li></ul></section>
|
|
193
193
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
|
194
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>
|
|
195
195
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -212,7 +212,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
212
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>
|
|
213
213
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
214
214
|
<ul>
|
|
215
|
-
<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/206c227/src/source/catalog.ts#L117">src/source/catalog.ts:117</a></li></ul></aside></li></ul></section>
|
|
216
216
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
|
217
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>
|
|
218
218
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -234,7 +234,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
234
234
|
</div></li></ul></div>
|
|
235
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">
|
|
236
236
|
<ul>
|
|
237
|
-
<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/206c227/src/source/catalog.ts#L65">src/source/catalog.ts:65</a></li></ul></aside></li></ul></section>
|
|
238
238
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
|
239
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>
|
|
240
240
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -247,7 +247,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
247
247
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
248
248
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
|
|
249
249
|
<ul>
|
|
250
|
-
<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/206c227/src/source/catalog.ts#L154">src/source/catalog.ts:154</a></li></ul></aside></li></ul></section>
|
|
251
251
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
|
|
252
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>
|
|
253
253
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -260,7 +260,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
260
260
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
261
261
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
|
|
262
262
|
<ul>
|
|
263
|
-
<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/206c227/src/source/catalog.ts#L160">src/source/catalog.ts:160</a></li></ul></aside></li></ul></section>
|
|
264
264
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
|
265
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>
|
|
266
266
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -273,7 +273,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
273
273
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
274
274
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
|
|
275
275
|
<ul>
|
|
276
|
-
<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/206c227/src/source/catalog.ts#L150">src/source/catalog.ts:150</a></li></ul></aside></li></ul></section></section></div>
|
|
277
277
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
278
278
|
<div class="tsd-navigation settings">
|
|
279
279
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|