@coveo/push-api-client 2.6.6 → 2.7.0
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/APICore.js +43 -0
- package/dist/APICore.js.map +1 -0
- package/dist/definitions/APICore.d.ts +11 -0
- package/dist/definitions/source/catalog.d.ts +1 -0
- package/dist/definitions/source/documentUploader.d.ts +3 -2
- package/dist/definitions/source/push.d.ts +5 -5
- package/dist/definitions/uploadStrategy/fileContainerStrategy.d.ts +4 -4
- package/dist/definitions/uploadStrategy/streamChunkStrategy.d.ts +4 -4
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +24 -17
- 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 +40 -43
- 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/source/catalog.js +4 -5
- package/dist/source/catalog.js.map +1 -1
- package/dist/source/documentUploader.js +2 -3
- package/dist/source/documentUploader.js.map +1 -1
- package/dist/source/documentUploader.spec.js +6 -19
- package/dist/source/documentUploader.spec.js.map +1 -1
- package/dist/source/push.js +7 -11
- package/dist/source/push.js.map +1 -1
- package/dist/source/push.spec.js +22 -50
- package/dist/source/push.spec.js.map +1 -1
- package/dist/uploadStrategy/fileContainerStrategy.js +4 -5
- package/dist/uploadStrategy/fileContainerStrategy.js.map +1 -1
- package/dist/uploadStrategy/fileContainerStrategy.spec.js +12 -28
- package/dist/uploadStrategy/fileContainerStrategy.spec.js.map +1 -1
- package/dist/uploadStrategy/streamChunkStrategy.js +5 -6
- package/dist/uploadStrategy/streamChunkStrategy.js.map +1 -1
- package/dist/uploadStrategy/streamChunkStrategy.spec.js +10 -34
- package/dist/uploadStrategy/streamChunkStrategy.spec.js.map +1 -1
- package/package.json +2 -1
- package/dist/definitions/help/axiosUtils.d.ts +0 -2
- package/dist/help/axiosUtils.js +0 -12
- package/dist/help/axiosUtils.js.map +0 -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/df137a4/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/df137a4/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/df137a4/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/df137a4/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/df137a4/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">
|
|
@@ -36,7 +36,8 @@
|
|
|
36
36
|
</div></section>
|
|
37
37
|
<section class="tsd-index-section">
|
|
38
38
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
39
|
-
<div class="tsd-index-list"><a href="CatalogSource.html#
|
|
39
|
+
<div class="tsd-index-list"><a href="CatalogSource.html#api" 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>api</span></a>
|
|
40
|
+
<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"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>apikey</span></a>
|
|
40
41
|
<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>
|
|
41
42
|
<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>
|
|
42
43
|
<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>
|
|
@@ -81,38 +82,43 @@
|
|
|
81
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>
|
|
82
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">
|
|
83
84
|
<ul>
|
|
84
|
-
<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/df137a4/src/source/catalog.ts#L46">src/source/catalog.ts:46</a></li></ul></aside></li></ul></section></section>
|
|
85
86
|
<section class="tsd-panel-group tsd-member-group">
|
|
86
87
|
<h2>Properties</h2>
|
|
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
|
+
<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
|
+
<div class="tsd-signature">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">APICore</span></div><aside class="tsd-sources">
|
|
91
|
+
<ul>
|
|
92
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/df137a4/src/source/catalog.ts#L33">src/source/catalog.ts:33</a></li></ul></aside></section>
|
|
87
93
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
|
|
88
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>
|
|
89
95
|
<div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
90
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>
|
|
91
97
|
</div><aside class="tsd-sources">
|
|
92
98
|
<ul>
|
|
93
|
-
<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/df137a4/src/source/catalog.ts#L47">src/source/catalog.ts:47</a></li></ul></aside></section>
|
|
94
100
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
|
95
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>
|
|
96
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">
|
|
97
103
|
<ul>
|
|
98
|
-
<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/df137a4/src/source/catalog.ts#L34">src/source/catalog.ts:34</a></li></ul></aside></section>
|
|
99
105
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
|
|
100
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>
|
|
101
107
|
<div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
108
|
<div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
|
|
103
109
|
</div><aside class="tsd-sources">
|
|
104
110
|
<ul>
|
|
105
|
-
<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/df137a4/src/source/catalog.ts#L48">src/source/catalog.ts:48</a></li></ul></aside></section>
|
|
106
112
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
|
107
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>
|
|
108
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">
|
|
109
115
|
<ul>
|
|
110
|
-
<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/df137a4/src/source/catalog.ts#L32">src/source/catalog.ts:32</a></li></ul></aside></section>
|
|
111
117
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
112
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>
|
|
113
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">
|
|
114
120
|
<ul>
|
|
115
|
-
<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/df137a4/src/source/catalog.ts#L35">src/source/catalog.ts:35</a></li></ul></aside></section></section>
|
|
116
122
|
<section class="tsd-panel-group tsd-member-group">
|
|
117
123
|
<h2>Accessors</h2>
|
|
118
124
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
|
@@ -122,7 +128,7 @@
|
|
|
122
128
|
<li class="tsd-description">
|
|
123
129
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
|
124
130
|
<ul>
|
|
125
|
-
<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/df137a4/src/source/catalog.ts#L76">src/source/catalog.ts:76</a></li></ul></aside></li></ul></section></section>
|
|
126
132
|
<section class="tsd-panel-group tsd-member-group">
|
|
127
133
|
<h2>Methods</h2>
|
|
128
134
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocuments" class="tsd-anchor"></a>
|
|
@@ -144,7 +150,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
144
150
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
145
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">
|
|
146
152
|
<ul>
|
|
147
|
-
<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/df137a4/src/source/catalog.ts#L104">src/source/catalog.ts:104</a></li></ul></aside></li></ul></section>
|
|
148
154
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchStreamDocumentsFromFiles" class="tsd-anchor"></a>
|
|
149
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>
|
|
150
156
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -168,7 +174,7 @@ See <a href="https://docs.coveo.com/en/lb4a0344">How to Stream Your Catalog Data
|
|
|
168
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>
|
|
169
175
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
170
176
|
<ul>
|
|
171
|
-
<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/df137a4/src/source/catalog.ts#L139">src/source/catalog.ts:139</a></li></ul></aside></li></ul></section>
|
|
172
178
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
|
173
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>
|
|
174
180
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -189,7 +195,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
189
195
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
190
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">
|
|
191
197
|
<ul>
|
|
192
|
-
<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/df137a4/src/source/catalog.ts#L88">src/source/catalog.ts:88</a></li></ul></aside></li></ul></section>
|
|
193
199
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
|
194
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>
|
|
195
201
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -212,7 +218,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
212
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>
|
|
213
219
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
214
220
|
<ul>
|
|
215
|
-
<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/df137a4/src/source/catalog.ts#L119">src/source/catalog.ts:119</a></li></ul></aside></li></ul></section>
|
|
216
222
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
|
217
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>
|
|
218
224
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -234,7 +240,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
234
240
|
</div></li></ul></div>
|
|
235
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">
|
|
236
242
|
<ul>
|
|
237
|
-
<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/df137a4/src/source/catalog.ts#L67">src/source/catalog.ts:67</a></li></ul></aside></li></ul></section>
|
|
238
244
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
|
239
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>
|
|
240
246
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -247,7 +253,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
247
253
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
248
254
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileContainerStrategy</span></h4><aside class="tsd-sources">
|
|
249
255
|
<ul>
|
|
250
|
-
<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/df137a4/src/source/catalog.ts#L156">src/source/catalog.ts:156</a></li></ul></aside></li></ul></section>
|
|
251
257
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="streamChunkStrategy" class="tsd-anchor"></a>
|
|
252
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>
|
|
253
259
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -260,7 +266,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
260
266
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
261
267
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamChunkStrategy</span></h4><aside class="tsd-sources">
|
|
262
268
|
<ul>
|
|
263
|
-
<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/df137a4/src/source/catalog.ts#L161">src/source/catalog.ts:161</a></li></ul></aside></li></ul></section>
|
|
264
270
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
|
265
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>
|
|
266
272
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -273,7 +279,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
273
279
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
274
280
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StreamUrlBuilder</span></h4><aside class="tsd-sources">
|
|
275
281
|
<ul>
|
|
276
|
-
<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/df137a4/src/source/catalog.ts#L152">src/source/catalog.ts:152</a></li></ul></aside></li></ul></section></section></div>
|
|
277
283
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
278
284
|
<div class="tsd-navigation settings">
|
|
279
285
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -301,6 +307,7 @@ See <a href="https://docs.coveo.com/en/l62e0540">Full Document Update</a></p>
|
|
|
301
307
|
<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>
|
|
302
308
|
<ul>
|
|
303
309
|
<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>
|
|
310
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CatalogSource.html#api" 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>api</a></li>
|
|
304
311
|
<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>
|
|
305
312
|
<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>
|
|
306
313
|
<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>
|