@coveo/push-api-client 2.8.8 → 2.8.10
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/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +17 -17
- package/dist/docs/classes/DocumentBuilder.html +29 -29
- 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/package.json +1 -1
|
@@ -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/2b6c540/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/2b6c540/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/2b6c540/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/2b6c540/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/2b6c540/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">
|
|
@@ -82,43 +82,43 @@
|
|
|
82
82
|
<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>
|
|
83
83
|
<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">
|
|
84
84
|
<ul>
|
|
85
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
85
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></li></ul></section></section>
|
|
86
86
|
<section class="tsd-panel-group tsd-member-group">
|
|
87
87
|
<h2>Properties</h2>
|
|
88
88
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="api" class="tsd-anchor"></a>
|
|
89
89
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>api</span><a href="#api" 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
90
|
<div class="tsd-signature">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">APICore</span></div><aside class="tsd-sources">
|
|
91
91
|
<ul>
|
|
92
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
92
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
|
|
93
93
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
|
|
94
94
|
<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>
|
|
95
95
|
<div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
96
96
|
<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>
|
|
97
97
|
</div><aside class="tsd-sources">
|
|
98
98
|
<ul>
|
|
99
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
99
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
|
|
100
100
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
|
101
101
|
<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>
|
|
102
102
|
<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">
|
|
103
103
|
<ul>
|
|
104
|
-
<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/2b6c540/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section>
|
|
105
105
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
|
|
106
106
|
<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>
|
|
107
107
|
<div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
108
108
|
<div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
|
|
109
109
|
</div><aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
111
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L48">src/source/catalog.ts:48</a></li></ul></aside></section>
|
|
112
112
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
|
113
113
|
<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>
|
|
114
114
|
<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">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
|
|
117
117
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
118
118
|
<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>
|
|
119
119
|
<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">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L35">src/source/catalog.ts:35</a></li></ul></aside></section></section>
|
|
122
122
|
<section class="tsd-panel-group tsd-member-group">
|
|
123
123
|
<h2>Accessors</h2>
|
|
124
124
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
|
@@ -128,7 +128,7 @@
|
|
|
128
128
|
<li class="tsd-description">
|
|
129
129
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
|
130
130
|
<ul>
|
|
131
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
131
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L76">src/source/catalog.ts:76</a></li></ul></aside></li></ul></section></section>
|
|
132
132
|
<section class="tsd-panel-group tsd-member-group">
|
|
133
133
|
<h2>Methods</h2>
|
|
134
134
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
|
|
@@ -150,7 +150,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
150
150
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
151
151
|
<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">
|
|
152
152
|
<ul>
|
|
153
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
153
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L104">src/source/catalog.ts:104</a></li></ul></aside></li></ul></section>
|
|
154
154
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
|
|
155
155
|
<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>
|
|
156
156
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -174,7 +174,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
174
174
|
<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>
|
|
175
175
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
176
176
|
<ul>
|
|
177
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
177
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L139">src/source/catalog.ts:139</a></li></ul></aside></li></ul></section>
|
|
178
178
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
|
179
179
|
<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>
|
|
180
180
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -195,7 +195,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
195
195
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
196
196
|
<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">
|
|
197
197
|
<ul>
|
|
198
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
198
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L88">src/source/catalog.ts:88</a></li></ul></aside></li></ul></section>
|
|
199
199
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
|
200
200
|
<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>
|
|
201
201
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -218,7 +218,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
218
218
|
<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>
|
|
219
219
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
220
220
|
<ul>
|
|
221
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
221
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L119">src/source/catalog.ts:119</a></li></ul></aside></li></ul></section>
|
|
222
222
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
|
223
223
|
<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>
|
|
224
224
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -240,7 +240,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
240
240
|
</div></li></ul></div>
|
|
241
241
|
<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">
|
|
242
242
|
<ul>
|
|
243
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
243
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L67">src/source/catalog.ts:67</a></li></ul></aside></li></ul></section>
|
|
244
244
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
|
245
245
|
<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>
|
|
246
246
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -253,7 +253,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
253
253
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
254
254
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
|
|
255
255
|
<ul>
|
|
256
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
256
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L156">src/source/catalog.ts:156</a></li></ul></aside></li></ul></section>
|
|
257
257
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
|
|
258
258
|
<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>
|
|
259
259
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -266,7 +266,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
266
266
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
267
267
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
|
|
268
268
|
<ul>
|
|
269
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
269
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L161">src/source/catalog.ts:161</a></li></ul></aside></li></ul></section>
|
|
270
270
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
|
271
271
|
<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>
|
|
272
272
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -279,7 +279,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
279
279
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
280
280
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
|
|
281
281
|
<ul>
|
|
282
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
282
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/2b6c540/src/source/catalog.ts#L152">src/source/catalog.ts:152</a></li></ul></aside></li></ul></section></section></div>
|
|
283
283
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
284
284
|
<div class="tsd-navigation settings">
|
|
285
285
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|