@coveo/push-api-client 2.5.15 → 2.5.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +14 -14
- package/dist/docs/classes/DocumentBuilder.html +27 -27
- package/dist/docs/classes/FieldAnalyser.html +11 -11
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +3 -3
- package/dist/docs/classes/PushSource.html +22 -22
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +3 -3
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +3 -3
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +6 -6
- package/dist/docs/classes/errors.InvalidDocument.html +6 -6
- package/dist/docs/classes/errors.InvalidPermanentId.html +6 -6
- package/dist/docs/classes/errors.NotAFileError.html +6 -6
- package/dist/docs/classes/errors.NotAJsonFileError.html +6 -6
- package/dist/docs/classes/errors.PrivilegeError.html +7 -7
- package/dist/docs/classes/errors.UnsupportedAttribute.html +6 -6
- package/dist/docs/classes/errors.UnsupportedFieldError.html +9 -9
- package/dist/docs/enums/PlatformEnvironment.html +5 -5
- package/dist/docs/enums/SourceVisibility.html +4 -4
- 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 +4 -4
- package/dist/docs/modules/errors.html +1 -1
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
- package/dist/docs/types/CompressionType.html +1 -1
- package/dist/docs/types/FailedUploadCallback.html +1 -1
- package/dist/docs/types/Metadata.html +1 -1
- package/dist/docs/types/MetadataValue.html +1 -1
- package/dist/docs/types/PlatformUrlOptions.html +1 -1
- package/dist/docs/types/SecurityIdentityType.html +1 -1
- package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
- package/dist/docs/types/Transformer.html +1 -1
- package/dist/docs/variables/BuiltInTransformers.html +1 -1
- package/dist/docs/variables/Source.html +1 -1
- package/package.json +6 -6
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">FieldAnalyser</span></li></ul></section><aside class="tsd-sources">
|
23
23
|
<ul>
|
24
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
24
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L18">src/fieldAnalyser/fieldAnalyser.ts:18</a></li></ul></aside>
|
25
25
|
<section class="tsd-panel-group tsd-index-group">
|
26
26
|
<section class="tsd-panel tsd-index-panel">
|
27
27
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -60,24 +60,24 @@
|
|
60
60
|
<h5>platformClient: <span class="tsd-signature-type">PlatformClient</span></h5></li></ul></div>
|
61
61
|
<h4 class="tsd-returns-title">Returns <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h4><aside class="tsd-sources">
|
62
62
|
<ul>
|
63
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
63
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
|
64
64
|
<section class="tsd-panel-group tsd-member-group">
|
65
65
|
<h2>Properties</h2>
|
66
66
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="existingFields" class="tsd-anchor"></a>
|
67
67
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>existing<wbr/>Fields</span><a href="#existingFields" 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>
|
68
68
|
<div class="tsd-signature">existing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
69
69
|
<ul>
|
70
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
70
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
|
71
71
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="inconsistencies" class="tsd-anchor"></a>
|
72
72
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>inconsistencies</span><a href="#inconsistencies" 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>
|
73
73
|
<div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
|
74
74
|
<ul>
|
75
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
75
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
|
76
76
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="missingFields" class="tsd-anchor"></a>
|
77
77
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>missing<wbr/>Fields</span><a href="#missingFields" 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>
|
78
78
|
<div class="tsd-signature">missing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldStore</span></div><aside class="tsd-sources">
|
79
79
|
<ul>
|
80
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
80
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section></section>
|
81
81
|
<section class="tsd-panel-group tsd-member-group">
|
82
82
|
<h2>Methods</h2>
|
83
83
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
|
@@ -96,7 +96,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
96
96
|
<h5>batch: <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
97
97
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><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></h4><aside class="tsd-sources">
|
98
98
|
<ul>
|
99
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
99
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
|
100
100
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensureExistingFields" class="tsd-anchor"></a>
|
101
101
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Existing<wbr/>Fields</span><a href="#ensureExistingFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
102
102
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -104,7 +104,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
104
104
|
<li class="tsd-description">
|
105
105
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
106
106
|
<ul>
|
107
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
107
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
|
108
108
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensurePermanentId" class="tsd-anchor"></a>
|
109
109
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Permanent<wbr/>Id</span><a href="#ensurePermanentId" 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>
|
110
110
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -117,7 +117,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
117
117
|
<h5>fieldStore: <span class="tsd-signature-type">FieldStore</span></h5></li></ul></div>
|
118
118
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
119
119
|
<ul>
|
120
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
120
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
|
121
121
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="removeInconsistentFields" class="tsd-anchor"></a>
|
122
122
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>remove<wbr/>Inconsistent<wbr/>Fields</span><a href="#removeInconsistentFields" 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>
|
123
123
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -125,7 +125,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
125
125
|
<li class="tsd-description">
|
126
126
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
127
127
|
<ul>
|
128
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
128
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
|
129
129
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="report" class="tsd-anchor"></a>
|
130
130
|
<h3 class="tsd-anchor-link"><span>report</span><a href="#report" 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>
|
131
131
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -137,7 +137,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
137
137
|
</div>
|
138
138
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4><aside class="tsd-sources">
|
139
139
|
<ul>
|
140
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
140
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
|
141
141
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="storeMetadata" class="tsd-anchor"></a>
|
142
142
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>store<wbr/>Metadata</span><a href="#storeMetadata" 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>
|
143
143
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -152,7 +152,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
152
152
|
<h5>metadataValue: <a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a></h5></li></ul></div>
|
153
153
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
154
154
|
<ul>
|
155
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
155
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
|
156
156
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
157
157
|
<div class="tsd-navigation settings">
|
158
158
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
<ul class="tsd-hierarchy">
|
28
28
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
29
29
|
<ul>
|
30
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
30
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
|
31
31
|
<section class="tsd-panel-group tsd-index-group">
|
32
32
|
<section class="tsd-panel tsd-index-panel">
|
33
33
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -59,7 +59,7 @@
|
|
59
59
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
60
60
|
<h4 class="tsd-returns-title">Returns <a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
61
61
|
<ul>
|
62
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
62
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
|
63
63
|
<section class="tsd-panel-group tsd-member-group">
|
64
64
|
<h2>Methods</h2>
|
65
65
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
@@ -73,7 +73,7 @@
|
|
73
73
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
74
74
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
75
75
|
<ul>
|
76
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
76
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
|
77
77
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
78
78
|
<div class="tsd-navigation settings">
|
79
79
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -22,7 +22,7 @@
|
|
22
22
|
<ul class="tsd-hierarchy">
|
23
23
|
<li><span class="target">PushSource</span></li></ul></section><aside class="tsd-sources">
|
24
24
|
<ul>
|
25
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
25
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside>
|
26
26
|
<section class="tsd-panel-group tsd-index-group">
|
27
27
|
<section class="tsd-panel tsd-index-panel">
|
28
28
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -83,24 +83,24 @@
|
|
83
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>
|
84
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
85
|
<ul>
|
86
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
86
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
|
87
87
|
<section class="tsd-panel-group tsd-member-group">
|
88
88
|
<h2>Properties</h2>
|
89
89
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
90
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>
|
91
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">
|
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/cd8638d/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
|
94
94
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
|
95
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>
|
96
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">
|
97
97
|
<ul>
|
98
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
98
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
|
99
99
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
100
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>
|
101
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">
|
102
102
|
<ul>
|
103
|
-
<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/cd8638d/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
|
104
104
|
<section class="tsd-panel-group tsd-member-group">
|
105
105
|
<h2>Accessors</h2>
|
106
106
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
|
@@ -110,7 +110,7 @@
|
|
110
110
|
<li class="tsd-description">
|
111
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
112
|
<ul>
|
113
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
113
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
|
114
114
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
115
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>
|
116
116
|
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
|
@@ -118,7 +118,7 @@
|
|
118
118
|
<li class="tsd-description">
|
119
119
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
120
120
|
<ul>
|
121
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
121
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
|
122
122
|
<section class="tsd-panel-group tsd-member-group">
|
123
123
|
<h2>Methods</h2>
|
124
124
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
|
@@ -140,7 +140,7 @@
|
|
140
140
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
141
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
142
|
<ul>
|
143
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
143
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
|
144
144
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
145
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>
|
146
146
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -160,7 +160,7 @@
|
|
160
160
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
161
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
162
|
<ul>
|
163
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
163
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
|
164
164
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
165
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>
|
166
166
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -183,7 +183,7 @@
|
|
183
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>
|
184
184
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
185
185
|
<ul>
|
186
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
186
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
|
187
187
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
188
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>
|
189
189
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -205,7 +205,7 @@
|
|
205
205
|
</div></li></ul></div>
|
206
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
207
|
<ul>
|
208
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
208
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
|
209
209
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
|
210
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>
|
211
211
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -218,7 +218,7 @@
|
|
218
218
|
<h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
|
219
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
220
|
<ul>
|
221
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
221
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
|
222
222
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
|
223
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>
|
224
224
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -237,7 +237,7 @@
|
|
237
237
|
<h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
|
238
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
239
|
<ul>
|
240
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
240
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
|
241
241
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
|
242
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>
|
243
243
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -256,7 +256,7 @@
|
|
256
256
|
<h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
|
257
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
258
|
<ul>
|
259
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
259
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
|
260
260
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
|
261
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>
|
262
262
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -276,7 +276,7 @@
|
|
276
276
|
<h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
|
277
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
278
|
<ul>
|
279
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
279
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
|
280
280
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
|
281
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>
|
282
282
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -294,7 +294,7 @@
|
|
294
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>
|
295
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
296
|
<ul>
|
297
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
297
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
|
298
298
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
|
299
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>
|
300
300
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -313,7 +313,7 @@
|
|
313
313
|
<h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
|
314
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
315
|
<ul>
|
316
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
316
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
|
317
317
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
|
318
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>
|
319
319
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -332,7 +332,7 @@
|
|
332
332
|
<h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
|
333
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
334
|
<ul>
|
335
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
335
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
|
336
336
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
337
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>
|
338
338
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -345,7 +345,7 @@
|
|
345
345
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
346
346
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
|
347
347
|
<ul>
|
348
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
348
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
|
349
349
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
|
350
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>
|
351
351
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -364,7 +364,7 @@
|
|
364
364
|
<h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
|
365
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
366
|
<ul>
|
367
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
367
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
|
368
368
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
|
369
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>
|
370
370
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
@@ -382,7 +382,7 @@
|
|
382
382
|
<h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
|
383
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
384
|
<ul>
|
385
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
385
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
|
386
386
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
387
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>
|
388
388
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
@@ -395,7 +395,7 @@
|
|
395
395
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
396
396
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
|
397
397
|
<ul>
|
398
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
398
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
|
399
399
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
400
400
|
<div class="tsd-navigation settings">
|
401
401
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
<ul class="tsd-hierarchy">
|
28
28
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
29
29
|
<ul>
|
30
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
30
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
|
31
31
|
<section class="tsd-panel-group tsd-index-group">
|
32
32
|
<section class="tsd-panel tsd-index-panel">
|
33
33
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -59,7 +59,7 @@
|
|
59
59
|
<h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Email Security Provider'</span></h5></li></ul></div>
|
60
60
|
<h4 class="tsd-returns-title">Returns <a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
61
61
|
<ul>
|
62
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
62
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
|
63
63
|
<section class="tsd-panel-group tsd-member-group">
|
64
64
|
<h2>Methods</h2>
|
65
65
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
@@ -73,7 +73,7 @@
|
|
73
73
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
74
74
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
75
75
|
<ul>
|
76
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
76
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
|
77
77
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
78
78
|
<div class="tsd-navigation settings">
|
79
79
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
<ul class="tsd-hierarchy">
|
28
28
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
29
29
|
<ul>
|
30
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
30
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
|
31
31
|
<section class="tsd-panel-group tsd-index-group">
|
32
32
|
<section class="tsd-panel tsd-index-panel">
|
33
33
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -59,7 +59,7 @@
|
|
59
59
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
60
60
|
<h4 class="tsd-returns-title">Returns <a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
61
61
|
<ul>
|
62
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
62
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
|
63
63
|
<section class="tsd-panel-group tsd-member-group">
|
64
64
|
<h2>Methods</h2>
|
65
65
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
@@ -73,7 +73,7 @@
|
|
73
73
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
74
74
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
75
75
|
<ul>
|
76
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
76
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
|
77
77
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
78
78
|
<div class="tsd-navigation settings">
|
79
79
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">FieldTypeInconsistencyError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
23
23
|
<ul>
|
24
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
24
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
|
25
25
|
<section class="tsd-panel-group tsd-index-group">
|
26
26
|
<section class="tsd-panel tsd-index-panel">
|
27
27
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -58,7 +58,7 @@
|
|
58
58
|
<h4 class="tsd-returns-title">Returns <a href="errors.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</a></h4><aside class="tsd-sources">
|
59
59
|
<p>Overrides PushApiClientBaseError.constructor</p>
|
60
60
|
<ul>
|
61
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
61
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
|
62
62
|
<section class="tsd-panel-group tsd-member-group">
|
63
63
|
<h2>Properties</h2>
|
64
64
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
|
@@ -72,7 +72,7 @@
|
|
72
72
|
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Field Type Inconsistency Error'</span></div><aside class="tsd-sources">
|
73
73
|
<p>Overrides PushApiClientBaseError.name</p>
|
74
74
|
<ul>
|
75
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
75
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
|
76
76
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
|
77
77
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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>
|
78
78
|
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
@@ -103,13 +103,13 @@
|
|
103
103
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
104
104
|
<p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
|
105
105
|
<ul>
|
106
|
-
<li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
|
106
|
+
<li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
|
107
107
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
|
108
108
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
|
109
109
|
<div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
110
110
|
<p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
|
111
111
|
<ul>
|
112
|
-
<li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
|
112
|
+
<li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
|
113
113
|
<section class="tsd-panel-group tsd-member-group">
|
114
114
|
<h2>Methods</h2>
|
115
115
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
|
@@ -129,7 +129,7 @@
|
|
129
129
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
130
130
|
<p>Inherited from PushApiClientBaseError.captureStackTrace</p>
|
131
131
|
<ul>
|
132
|
-
<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
|
132
|
+
<li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
|
133
133
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
134
134
|
<div class="tsd-navigation settings">
|
135
135
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">InvalidDocument</span></li></ul></li></ul></section><aside class="tsd-sources">
|
23
23
|
<ul>
|
24
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
24
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L17">src/errors/validatorErrors.ts:17</a></li></ul></aside>
|
25
25
|
<section class="tsd-panel-group tsd-index-group">
|
26
26
|
<section class="tsd-panel tsd-index-panel">
|
27
27
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -60,7 +60,7 @@
|
|
60
60
|
<h4 class="tsd-returns-title">Returns <a href="errors.InvalidDocument.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidDocument</a></h4><aside class="tsd-sources">
|
61
61
|
<p>Overrides PushApiClientBaseError.constructor</p>
|
62
62
|
<ul>
|
63
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
63
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L19">src/errors/validatorErrors.ts:19</a></li></ul></aside></li></ul></section></section>
|
64
64
|
<section class="tsd-panel-group tsd-member-group">
|
65
65
|
<h2>Properties</h2>
|
66
66
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
|
@@ -74,7 +74,7 @@
|
|
74
74
|
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Invalid JSON Document Error'</span></div><aside class="tsd-sources">
|
75
75
|
<p>Overrides PushApiClientBaseError.name</p>
|
76
76
|
<ul>
|
77
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
77
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cd8638d/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
|
78
78
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
|
79
79
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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>
|
80
80
|
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
@@ -105,13 +105,13 @@
|
|
105
105
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
106
106
|
<p>Inherited from PushApiClientBaseError.prepareStackTrace</p>
|
107
107
|
<ul>
|
108
|
-
<li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside></section>
|
108
|
+
<li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:11</li></ul></aside></section>
|
109
109
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a>
|
110
110
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" 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>
|
111
111
|
<div class="tsd-signature">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
112
112
|
<p>Inherited from PushApiClientBaseError.stackTraceLimit</p>
|
113
113
|
<ul>
|
114
|
-
<li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section>
|
114
|
+
<li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:13</li></ul></aside></section></section>
|
115
115
|
<section class="tsd-panel-group tsd-member-group">
|
116
116
|
<h2>Methods</h2>
|
117
117
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
|
@@ -131,7 +131,7 @@
|
|
131
131
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
132
132
|
<p>Inherited from PushApiClientBaseError.captureStackTrace</p>
|
133
133
|
<ul>
|
134
|
-
<li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
|
134
|
+
<li>Defined in node_modules/@types/node/ts4.8/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
|
135
135
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
136
136
|
<div class="tsd-navigation settings">
|
137
137
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|