@coveo/push-api-client 2.4.18 → 2.4.28
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/highlight.css +49 -0
- package/dist/docs/assets/main.js +3 -3
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/assets/style.css +6 -82
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +15 -11
- package/dist/docs/classes/CatalogSource.html +67 -55
- package/dist/docs/classes/DocumentBuilder.html +139 -112
- package/dist/docs/classes/FieldAnalyser.html +59 -50
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +11 -7
- package/dist/docs/classes/PushSource.html +96 -76
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +11 -7
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +11 -7
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +17 -14
- package/dist/docs/classes/errors.InvalidDocument.html +17 -14
- package/dist/docs/classes/errors.InvalidPermanentId.html +17 -14
- package/dist/docs/classes/errors.NotAFileError.html +17 -14
- package/dist/docs/classes/errors.NotAJsonFileError.html +17 -14
- package/dist/docs/classes/errors.PrivilegeError.html +18 -15
- package/dist/docs/classes/errors.UnsupportedAttribute.html +17 -14
- package/dist/docs/classes/errors.UnsupportedFieldError.html +27 -23
- package/dist/docs/enums/PlatformEnvironment.html +7 -5
- package/dist/docs/enums/Region.html +3 -1
- package/dist/docs/enums/SourceVisibility.html +3 -1
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +4 -3
- package/dist/docs/index.html +49 -2
- package/dist/docs/interfaces/BatchUpdateDocuments.html +5 -3
- package/dist/docs/interfaces/Document.html +38 -36
- package/dist/docs/interfaces/SecurityIdentity.html +8 -6
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +7 -4
- package/dist/docs/interfaces/UploadBatchCallbackData.html +8 -6
- package/dist/docs/modules/errors.html +3 -1
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
- package/dist/docs/types/CompressionType.html +1 -1
- package/dist/docs/types/FailedUploadCallback.html +2 -3
- 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 +2 -3
- package/dist/docs/types/Transformer.html +2 -3
- package/dist/docs/variables/BuiltInTransformers.html +1 -1
- package/dist/docs/variables/Source.html +1 -1
- package/dist/source/catalog.stream.spec.js +13 -0
- package/dist/source/catalog.stream.spec.js.map +1 -1
- package/dist/source/documentUploader.js +3 -2
- package/dist/source/documentUploader.js.map +1 -1
- package/package.json +13 -13
@@ -20,7 +20,9 @@
|
|
20
20
|
<section class="tsd-panel tsd-hierarchy">
|
21
21
|
<h4>Hierarchy</h4>
|
22
22
|
<ul class="tsd-hierarchy">
|
23
|
-
<li><span class="target">PushSource</span></li></ul></section>
|
23
|
+
<li><span class="target">PushSource</span></li></ul></section><aside class="tsd-sources">
|
24
|
+
<ul>
|
25
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside>
|
24
26
|
<section class="tsd-panel-group tsd-index-group">
|
25
27
|
<section class="tsd-panel tsd-index-panel">
|
26
28
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -32,13 +34,13 @@
|
|
32
34
|
</div></section>
|
33
35
|
<section class="tsd-index-section">
|
34
36
|
<h3 class="tsd-index-heading">Properties</h3>
|
35
|
-
<div class="tsd-index-list"><a href="PushSource.html#options" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>options</span></a>
|
37
|
+
<div class="tsd-index-list"><a href="PushSource.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"><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>options</span></a>
|
36
38
|
<a href="PushSource.html#platformClient" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>
|
37
|
-
<a href="PushSource.html#defaultOptions" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>
|
39
|
+
<a href="PushSource.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>
|
38
40
|
</div></section>
|
39
41
|
<section class="tsd-index-section">
|
40
42
|
<h3 class="tsd-index-heading">Accessors</h3>
|
41
|
-
<div class="tsd-index-list"><a href="PushSource.html#documentsAxiosConfig" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>documents<wbr/>Axios<wbr/>Config</span></a>
|
43
|
+
<div class="tsd-index-list"><a href="PushSource.html#documentsAxiosConfig" class="tsd-index-link tsd-kind-accessor 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="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>documents<wbr/>Axios<wbr/>Config</span></a>
|
42
44
|
<a href="PushSource.html#identity" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><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><span>identity</span></a>
|
43
45
|
</div></section>
|
44
46
|
<section class="tsd-index-section">
|
@@ -54,18 +56,17 @@
|
|
54
56
|
<a href="PushSource.html#deleteDocumentsOlderThan" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Documents<wbr/>Older<wbr/>Than</span></a>
|
55
57
|
<a href="PushSource.html#deleteOldSecurityIdentities" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Old<wbr/>Security<wbr/>Identities</span></a>
|
56
58
|
<a href="PushSource.html#deleteSecurityIdentity" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Security<wbr/>Identity</span></a>
|
57
|
-
<a href="PushSource.html#fileContainerStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>file<wbr/>Container<wbr/>Strategy</span></a>
|
59
|
+
<a href="PushSource.html#fileContainerStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>file<wbr/>Container<wbr/>Strategy</span></a>
|
58
60
|
<a href="PushSource.html#manageSecurityIdentities" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>manage<wbr/>Security<wbr/>Identities</span></a>
|
59
61
|
<a href="PushSource.html#setSourceStatus" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Source<wbr/>Status</span></a>
|
60
|
-
<a href="PushSource.html#urlBuilder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>url<wbr/>Builder</span></a>
|
62
|
+
<a href="PushSource.html#urlBuilder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>url<wbr/>Builder</span></a>
|
61
63
|
</div></section></div></details></section></section>
|
62
64
|
<section class="tsd-panel-group tsd-member-group">
|
63
65
|
<h2>Constructors</h2>
|
64
66
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
|
65
67
|
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
66
68
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
67
|
-
<li class="tsd-signature" id="constructor.new_PushSource">new <wbr/>Push<wbr/>Source<span class="tsd-signature-symbol">(</span>apikey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, organizationid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<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><a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a></li
|
68
|
-
<ul class="tsd-descriptions">
|
69
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_PushSource">new <wbr/>Push<wbr/>Source<span class="tsd-signature-symbol">(</span>apikey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, organizationid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<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><a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a><a href="#constructor.new_PushSource" 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>
|
69
70
|
<li class="tsd-description">
|
70
71
|
<div class="tsd-parameters">
|
71
72
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -80,47 +81,50 @@
|
|
80
81
|
</div></li>
|
81
82
|
<li>
|
82
83
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a></h5></li></ul></div>
|
83
|
-
<h4 class="tsd-returns-title">Returns <a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a></h4
|
84
|
+
<h4 class="tsd-returns-title">Returns <a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a></h4><aside class="tsd-sources">
|
85
|
+
<ul>
|
86
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
|
84
87
|
<section class="tsd-panel-group tsd-member-group">
|
85
88
|
<h2>Properties</h2>
|
86
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="options" class="tsd-anchor"></a>
|
89
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
87
90
|
<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>
|
88
91
|
<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">
|
89
92
|
<ul>
|
90
|
-
<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/6f5535c/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
|
91
94
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
|
92
95
|
<h3 class="tsd-anchor-link"><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>
|
93
96
|
<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">
|
94
97
|
<ul>
|
95
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
96
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="defaultOptions" class="tsd-anchor"></a>
|
98
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
|
99
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
97
100
|
<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>
|
98
101
|
<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">
|
99
102
|
<ul>
|
100
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
103
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
|
101
104
|
<section class="tsd-panel-group tsd-member-group">
|
102
105
|
<h2>Accessors</h2>
|
103
|
-
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
|
106
|
+
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
|
104
107
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>documents<wbr/>Axios<wbr/>Config</span><a href="#documentsAxiosConfig" 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>
|
105
|
-
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
|
106
|
-
<li class="tsd-signature" id="documentsAxiosConfig.documentsAxiosConfig-1"><span class="tsd-signature-symbol">get</span> documentsAxiosConfig<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li
|
107
|
-
<ul class="tsd-descriptions">
|
108
|
+
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-private">
|
109
|
+
<li class="tsd-signature" id="documentsAxiosConfig.documentsAxiosConfig-1"><span class="tsd-signature-symbol">get</span> documentsAxiosConfig<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
108
110
|
<li class="tsd-description">
|
109
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4
|
111
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
112
|
+
<ul>
|
113
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
|
110
114
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
111
115
|
<h3 class="tsd-anchor-link"><span>identity</span><a href="#identity" 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>
|
112
116
|
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
|
113
|
-
<li class="tsd-signature" id="identity.identity-1"><span class="tsd-signature-symbol">get</span> identity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentity</span></li
|
114
|
-
<ul class="tsd-descriptions">
|
117
|
+
<li class="tsd-signature" id="identity.identity-1"><span class="tsd-signature-symbol">get</span> identity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentity</span></li>
|
115
118
|
<li class="tsd-description">
|
116
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4
|
119
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
120
|
+
<ul>
|
121
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
|
117
122
|
<section class="tsd-panel-group tsd-member-group">
|
118
123
|
<h2>Methods</h2>
|
119
124
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
|
120
125
|
<h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update<wbr/>Document</span><a href="#addOrUpdateDocument" 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>
|
121
126
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
122
|
-
<li class="tsd-signature" id="addOrUpdateDocument.addOrUpdateDocument-1">add<wbr/>Or<wbr/>Update<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, docBuilder<span class="tsd-signature-symbol">: </span><a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><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-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></li
|
123
|
-
<ul class="tsd-descriptions">
|
127
|
+
<li class="tsd-signature tsd-anchor-link" id="addOrUpdateDocument.addOrUpdateDocument-1">add<wbr/>Or<wbr/>Update<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, docBuilder<span class="tsd-signature-symbol">: </span><a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><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-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><a href="#addOrUpdateDocument.addOrUpdateDocument-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>
|
124
128
|
<li class="tsd-description">
|
125
129
|
<div class="tsd-comment tsd-typography"><p>Adds or updates an individual item in a push source. See <a href="https://docs.coveo.com/en/133">Adding a Single Item in a Push Source</a>.</p>
|
126
130
|
|
@@ -134,12 +138,13 @@
|
|
134
138
|
<h5>docBuilder: <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h5></li>
|
135
139
|
<li>
|
136
140
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
137
|
-
<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
|
141
|
+
<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">
|
142
|
+
<ul>
|
143
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
|
138
144
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
139
145
|
<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>
|
140
146
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
141
|
-
<li class="tsd-signature" id="batchUpdateDocuments.batchUpdateDocuments-1">batch<wbr/>Update<wbr/>Documents<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batch<span class="tsd-signature-symbol">: </span><a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><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-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></li
|
142
|
-
<ul class="tsd-descriptions">
|
147
|
+
<li class="tsd-signature tsd-anchor-link" id="batchUpdateDocuments.batchUpdateDocuments-1">batch<wbr/>Update<wbr/>Documents<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batch<span class="tsd-signature-symbol">: </span><a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><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-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><a href="#batchUpdateDocuments.batchUpdateDocuments-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>
|
143
148
|
<li class="tsd-description">
|
144
149
|
<div class="tsd-comment tsd-typography"><p>Manage batches of items in a push source. See <a href="https://docs.coveo.com/en/90">Manage Batches of Items in a Push Source</a></p>
|
145
150
|
|
@@ -153,12 +158,13 @@
|
|
153
158
|
<h5>batch: <a href="../interfaces/BatchUpdateDocuments.html" class="tsd-signature-type" data-tsd-kind="Interface">BatchUpdateDocuments</a></h5></li>
|
154
159
|
<li>
|
155
160
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
156
|
-
<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
|
161
|
+
<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">
|
162
|
+
<ul>
|
163
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
|
157
164
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
158
165
|
<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>
|
159
166
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
160
|
-
<li class="tsd-signature" id="batchUpdateDocumentsFromFiles.batchUpdateDocumentsFromFiles-1">batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filesOrDirectories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></li
|
161
|
-
<ul class="tsd-descriptions">
|
167
|
+
<li class="tsd-signature tsd-anchor-link" id="batchUpdateDocumentsFromFiles.batchUpdateDocumentsFromFiles-1">batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filesOrDirectories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span><a href="#batchUpdateDocumentsFromFiles.batchUpdateDocumentsFromFiles-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>
|
162
168
|
<li class="tsd-description">
|
163
169
|
<div class="tsd-comment tsd-typography"><p>Manage batches of items in a push source from a list of JSON files. See <a href="https://docs.coveo.com/en/90">Manage Batches of Items in a Push Source</a></p>
|
164
170
|
</div>
|
@@ -175,12 +181,13 @@
|
|
175
181
|
</div></li>
|
176
182
|
<li>
|
177
183
|
<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>
|
178
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4
|
184
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
185
|
+
<ul>
|
186
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
|
179
187
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
180
188
|
<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>
|
181
189
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
182
|
-
<li class="tsd-signature" 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"> }</span><span class="tsd-signature-symbol">></span></li
|
183
|
-
<ul class="tsd-descriptions">
|
190
|
+
<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"> }</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>
|
184
191
|
<li class="tsd-description">
|
185
192
|
<div class="tsd-comment tsd-typography"><p>Create a new push source</p>
|
186
193
|
|
@@ -196,24 +203,26 @@
|
|
196
203
|
<h5>sourceVisibility: <a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a></h5>
|
197
204
|
<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>
|
198
205
|
</div></li></ul></div>
|
199
|
-
<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"> }</span><span class="tsd-signature-symbol">></span></h4
|
206
|
+
<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"> }</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
207
|
+
<ul>
|
208
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
|
200
209
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
|
201
210
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Fields</span><a href="#createFields" 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>
|
202
211
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
203
|
-
<li class="tsd-signature" id="createFields.createFields-1">create<wbr/>Fields<span class="tsd-signature-symbol">(</span>analyser<span class="tsd-signature-symbol">: </span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</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-type">void</span><span class="tsd-signature-symbol">></span></li
|
204
|
-
<ul class="tsd-descriptions">
|
212
|
+
<li class="tsd-signature tsd-anchor-link" id="createFields.createFields-1">create<wbr/>Fields<span class="tsd-signature-symbol">(</span>analyser<span class="tsd-signature-symbol">: </span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</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-type">void</span><span class="tsd-signature-symbol">></span><a href="#createFields.createFields-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>
|
205
213
|
<li class="tsd-description">
|
206
214
|
<div class="tsd-parameters">
|
207
215
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
208
216
|
<ul class="tsd-parameter-list">
|
209
217
|
<li>
|
210
218
|
<h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
|
211
|
-
<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
|
219
|
+
<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">
|
220
|
+
<ul>
|
221
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
|
212
222
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
|
213
223
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Or<wbr/>Update<wbr/>Security<wbr/>Identity<wbr/>Alias</span><a href="#createOrUpdateSecurityIdentityAlias" 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>
|
214
224
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
215
|
-
<li class="tsd-signature" id="createOrUpdateSecurityIdentityAlias.createOrUpdateSecurityIdentityAlias-1">create<wbr/>Or<wbr/>Update<wbr/>Security<wbr/>Identity<wbr/>Alias<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityIdentityAlias<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityAliasModel</span><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-type">void</span><span class="tsd-signature-symbol">></span></li
|
216
|
-
<ul class="tsd-descriptions">
|
225
|
+
<li class="tsd-signature tsd-anchor-link" id="createOrUpdateSecurityIdentityAlias.createOrUpdateSecurityIdentityAlias-1">create<wbr/>Or<wbr/>Update<wbr/>Security<wbr/>Identity<wbr/>Alias<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityIdentityAlias<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityAliasModel</span><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-type">void</span><span class="tsd-signature-symbol">></span><a href="#createOrUpdateSecurityIdentityAlias.createOrUpdateSecurityIdentityAlias-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>
|
217
226
|
<li class="tsd-description">
|
218
227
|
<div class="tsd-comment tsd-typography">
|
219
228
|
<h3>Deprecated</h3><p>use <code>identity.createOrUpdateSecurityIdentityAlias</code></p>
|
@@ -226,12 +235,13 @@
|
|
226
235
|
<h5>securityProviderId: <span class="tsd-signature-type">string</span></h5></li>
|
227
236
|
<li>
|
228
237
|
<h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
|
229
|
-
<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
|
238
|
+
<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">
|
239
|
+
<ul>
|
240
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
|
230
241
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
|
231
242
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Security<wbr/>Identity</span><a href="#createSecurityIdentity" 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>
|
232
243
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
233
|
-
<li class="tsd-signature" id="createSecurityIdentity.createSecurityIdentity-1">create<wbr/>Security<wbr/>Identity<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityIdentity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityModel</span><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-type">void</span><span class="tsd-signature-symbol">></span></li
|
234
|
-
<ul class="tsd-descriptions">
|
244
|
+
<li class="tsd-signature tsd-anchor-link" id="createSecurityIdentity.createSecurityIdentity-1">create<wbr/>Security<wbr/>Identity<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityIdentity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityModel</span><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-type">void</span><span class="tsd-signature-symbol">></span><a href="#createSecurityIdentity.createSecurityIdentity-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>
|
235
245
|
<li class="tsd-description">
|
236
246
|
<div class="tsd-comment tsd-typography">
|
237
247
|
<h3>Deprecated</h3><p>use <code>identity.createSecurityIdentity</code></p>
|
@@ -244,12 +254,13 @@
|
|
244
254
|
<h5>securityProviderId: <span class="tsd-signature-type">string</span></h5></li>
|
245
255
|
<li>
|
246
256
|
<h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
|
247
|
-
<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
|
257
|
+
<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">
|
258
|
+
<ul>
|
259
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
|
248
260
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
|
249
261
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Document</span><a href="#deleteDocument" 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>
|
250
262
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
251
|
-
<li class="tsd-signature" id="deleteDocument.deleteDocument-1">delete<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, deleteChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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-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></li
|
252
|
-
<ul class="tsd-descriptions">
|
263
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteDocument.deleteDocument-1">delete<wbr/>Document<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, deleteChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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-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><a href="#deleteDocument.deleteDocument-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>
|
253
264
|
<li class="tsd-description">
|
254
265
|
<div class="tsd-comment tsd-typography"><p>Deletes a specific item from a Push source. Optionally, the child items of that item can also be deleted. See <a href="https://docs.coveo.com/en/171">Deleting an Item in a Push Source</a>.</p>
|
255
266
|
|
@@ -263,12 +274,13 @@
|
|
263
274
|
<h5>documentId: <span class="tsd-signature-type">string</span></h5></li>
|
264
275
|
<li>
|
265
276
|
<h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
|
266
|
-
<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
|
277
|
+
<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">
|
278
|
+
<ul>
|
279
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
|
267
280
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
|
268
281
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Documents<wbr/>Older<wbr/>Than</span><a href="#deleteDocumentsOlderThan" 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>
|
269
282
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
270
|
-
<li class="tsd-signature" id="deleteDocumentsOlderThan.deleteDocumentsOlderThan-1">delete<wbr/>Documents<wbr/>Older<wbr/>Than<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, olderThan<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><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-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></li
|
271
|
-
<ul class="tsd-descriptions">
|
283
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteDocumentsOlderThan.deleteDocumentsOlderThan-1">delete<wbr/>Documents<wbr/>Older<wbr/>Than<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, olderThan<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><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-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><a href="#deleteDocumentsOlderThan.deleteDocumentsOlderThan-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>
|
272
284
|
<li class="tsd-description">
|
273
285
|
<div class="tsd-comment tsd-typography"><p>Deletes all items whose last update was made by a Push API operation whose orderingId is strictly lower than a specified value. See <a href="https://docs.coveo.com/en/131">Deleting Old Items in a Push Source</a>.</p>
|
274
286
|
|
@@ -280,12 +292,13 @@
|
|
280
292
|
<h5>sourceID: <span class="tsd-signature-type">string</span></h5></li>
|
281
293
|
<li>
|
282
294
|
<h5>olderThan: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
|
283
|
-
<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
|
295
|
+
<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">
|
296
|
+
<ul>
|
297
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
|
284
298
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
|
285
299
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Old<wbr/>Security<wbr/>Identities</span><a href="#deleteOldSecurityIdentities" 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>
|
286
300
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
287
|
-
<li class="tsd-signature" id="deleteOldSecurityIdentities.deleteOldSecurityIdentities-1">delete<wbr/>Old<wbr/>Security<wbr/>Identities<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batchDelete<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityDeleteOptions</span><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-type">void</span><span class="tsd-signature-symbol">></span></li
|
288
|
-
<ul class="tsd-descriptions">
|
301
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteOldSecurityIdentities.deleteOldSecurityIdentities-1">delete<wbr/>Old<wbr/>Security<wbr/>Identities<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batchDelete<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityDeleteOptions</span><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-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteOldSecurityIdentities.deleteOldSecurityIdentities-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>
|
289
302
|
<li class="tsd-description">
|
290
303
|
<div class="tsd-comment tsd-typography">
|
291
304
|
<h3>Deprecated</h3><p>use <code>identity.deleteOldSecurityIdentities</code></p>
|
@@ -298,12 +311,13 @@
|
|
298
311
|
<h5>securityProviderId: <span class="tsd-signature-type">string</span></h5></li>
|
299
312
|
<li>
|
300
313
|
<h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
|
301
|
-
<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
|
314
|
+
<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">
|
315
|
+
<ul>
|
316
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
|
302
317
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
|
303
318
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Security<wbr/>Identity</span><a href="#deleteSecurityIdentity" 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>
|
304
319
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
305
|
-
<li class="tsd-signature" id="deleteSecurityIdentity.deleteSecurityIdentity-1">delete<wbr/>Security<wbr/>Identity<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityIdentityToDelete<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityDelete</span><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-type">void</span><span class="tsd-signature-symbol">></span></li
|
306
|
-
<ul class="tsd-descriptions">
|
320
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteSecurityIdentity.deleteSecurityIdentity-1">delete<wbr/>Security<wbr/>Identity<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityIdentityToDelete<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityDelete</span><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-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteSecurityIdentity.deleteSecurityIdentity-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>
|
307
321
|
<li class="tsd-description">
|
308
322
|
<div class="tsd-comment tsd-typography">
|
309
323
|
<h3>Deprecated</h3><p>use <code>identity.deleteSecurityIdentity</code></p>
|
@@ -316,24 +330,26 @@
|
|
316
330
|
<h5>securityProviderId: <span class="tsd-signature-type">string</span></h5></li>
|
317
331
|
<li>
|
318
332
|
<h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
|
319
|
-
<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
|
320
|
-
<
|
333
|
+
<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">
|
334
|
+
<ul>
|
335
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
|
336
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
321
337
|
<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>
|
322
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
323
|
-
<li class="tsd-signature" id="fileContainerStrategy.fileContainerStrategy-1">file<wbr/>Container<wbr/>Strategy<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UploadStrategy</span></li
|
324
|
-
<ul class="tsd-descriptions">
|
338
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
339
|
+
<li class="tsd-signature tsd-anchor-link" id="fileContainerStrategy.fileContainerStrategy-1">file<wbr/>Container<wbr/>Strategy<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UploadStrategy</span><a href="#fileContainerStrategy.fileContainerStrategy-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>
|
325
340
|
<li class="tsd-description">
|
326
341
|
<div class="tsd-parameters">
|
327
342
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
328
343
|
<ul class="tsd-parameter-list">
|
329
344
|
<li>
|
330
345
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
331
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4
|
346
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
|
347
|
+
<ul>
|
348
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
|
332
349
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
|
333
350
|
<h3 class="tsd-anchor-link"><span>manage<wbr/>Security<wbr/>Identities</span><a href="#manageSecurityIdentities" 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>
|
334
351
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
335
|
-
<li class="tsd-signature" id="manageSecurityIdentities.manageSecurityIdentities-1">manage<wbr/>Security<wbr/>Identities<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batchConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityBatchConfig</span><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-type">void</span><span class="tsd-signature-symbol">></span></li
|
336
|
-
<ul class="tsd-descriptions">
|
352
|
+
<li class="tsd-signature tsd-anchor-link" id="manageSecurityIdentities.manageSecurityIdentities-1">manage<wbr/>Security<wbr/>Identities<span class="tsd-signature-symbol">(</span>securityProviderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, batchConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecurityIdentityBatchConfig</span><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-type">void</span><span class="tsd-signature-symbol">></span><a href="#manageSecurityIdentities.manageSecurityIdentities-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>
|
337
353
|
<li class="tsd-description">
|
338
354
|
<div class="tsd-comment tsd-typography">
|
339
355
|
<h3>Deprecated</h3><p>use <code>identity.manageSecurityIdentities</code></p>
|
@@ -346,12 +362,13 @@
|
|
346
362
|
<h5>securityProviderId: <span class="tsd-signature-type">string</span></h5></li>
|
347
363
|
<li>
|
348
364
|
<h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
|
349
|
-
<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
|
365
|
+
<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">
|
366
|
+
<ul>
|
367
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
|
350
368
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
|
351
369
|
<h3 class="tsd-anchor-link"><span>set<wbr/>Source<wbr/>Status</span><a href="#setSourceStatus" 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>
|
352
370
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
353
|
-
<li class="tsd-signature" id="setSourceStatus.setSourceStatus-1">set<wbr/>Source<wbr/>Status<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SourceStatus</span><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-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></li
|
354
|
-
<ul class="tsd-descriptions">
|
371
|
+
<li class="tsd-signature tsd-anchor-link" id="setSourceStatus.setSourceStatus-1">set<wbr/>Source<wbr/>Status<span class="tsd-signature-symbol">(</span>sourceID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SourceStatus</span><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-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><a href="#setSourceStatus.setSourceStatus-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>
|
355
372
|
<li class="tsd-description">
|
356
373
|
<div class="tsd-comment tsd-typography"><p>Set the status of a push source. See <a href="https://docs.coveo.com/en/35/">Updating the Status of a Push Source</a></p>
|
357
374
|
|
@@ -363,19 +380,22 @@
|
|
363
380
|
<h5>sourceID: <span class="tsd-signature-type">string</span></h5></li>
|
364
381
|
<li>
|
365
382
|
<h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
|
366
|
-
<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
|
367
|
-
<
|
383
|
+
<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">
|
384
|
+
<ul>
|
385
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
|
386
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
368
387
|
<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>
|
369
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
370
|
-
<li class="tsd-signature" id="urlBuilder.urlBuilder-1">url<wbr/>Builder<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PushUrlBuilder</span></li
|
371
|
-
<ul class="tsd-descriptions">
|
388
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
389
|
+
<li class="tsd-signature tsd-anchor-link" id="urlBuilder.urlBuilder-1">url<wbr/>Builder<span class="tsd-signature-symbol">(</span>sourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PushUrlBuilder</span><a href="#urlBuilder.urlBuilder-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>
|
372
390
|
<li class="tsd-description">
|
373
391
|
<div class="tsd-parameters">
|
374
392
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
375
393
|
<ul class="tsd-parameter-list">
|
376
394
|
<li>
|
377
395
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
378
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4
|
396
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
|
397
|
+
<ul>
|
398
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
|
379
399
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
380
400
|
<div class="tsd-navigation settings">
|
381
401
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -403,10 +423,10 @@
|
|
403
423
|
<li class="current tsd-kind-class"><a href="PushSource.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>Push<wbr/>Source</span></a>
|
404
424
|
<ul>
|
405
425
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PushSource.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>
|
406
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="PushSource.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>
|
426
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.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>
|
407
427
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="PushSource.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>
|
408
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="PushSource.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>
|
409
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="PushSource.html#documentsAxiosConfig" 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>documents<wbr/>Axios<wbr/>Config</a></li>
|
428
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.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>
|
429
|
+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#documentsAxiosConfig" 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>documents<wbr/>Axios<wbr/>Config</a></li>
|
410
430
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="PushSource.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>
|
411
431
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#addOrUpdateDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Or<wbr/>Update<wbr/>Document</a></li>
|
412
432
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#batchUpdateDocuments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>batch<wbr/>Update<wbr/>Documents</a></li>
|
@@ -419,10 +439,10 @@
|
|
419
439
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#deleteDocumentsOlderThan" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Documents<wbr/>Older<wbr/>Than</a></li>
|
420
440
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#deleteOldSecurityIdentities" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Old<wbr/>Security<wbr/>Identities</a></li>
|
421
441
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#deleteSecurityIdentity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Security<wbr/>Identity</a></li>
|
422
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#fileContainerStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>file<wbr/>Container<wbr/>Strategy</a></li>
|
442
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#fileContainerStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>file<wbr/>Container<wbr/>Strategy</a></li>
|
423
443
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#manageSecurityIdentities" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>manage<wbr/>Security<wbr/>Identities</a></li>
|
424
444
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#setSourceStatus" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Source<wbr/>Status</a></li>
|
425
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="PushSource.html#urlBuilder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>url<wbr/>Builder</a></li></ul></li></ul></nav></div></div>
|
445
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#urlBuilder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>url<wbr/>Builder</a></li></ul></li></ul></nav></div></div>
|
426
446
|
<div class="container tsd-generator">
|
427
447
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
428
448
|
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|