@coveo/push-api-client 2.5.22 → 2.5.24
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/search.js +1 -1
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +31 -17
- package/dist/docs/classes/DocumentBuilder.html +40 -33
- package/dist/docs/classes/FieldAnalyser.html +18 -11
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/PushSource.html +39 -25
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
- package/dist/docs/classes/errors.InvalidDocument.html +3 -3
- package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
- package/dist/docs/classes/errors.NotAFileError.html +3 -3
- package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
- package/dist/docs/classes/errors.PrivilegeError.html +4 -4
- package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
- package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
- package/dist/docs/enums/PlatformEnvironment.html +5 -5
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
- package/dist/docs/interfaces/BatchUpdateDocuments.html +4 -4
- package/dist/docs/interfaces/Document.html +16 -16
- 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 +2 -2
- 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 +2 -2
- package/dist/docs/variables/Source.html +1 -1
- package/package.json +6 -6
@@ -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/b427571/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">
|
@@ -38,6 +38,11 @@
|
|
38
38
|
<div class="tsd-index-list"><a href="UserSecurityIdentityBuilder.html#constructor" class="tsd-index-link tsd-kind-constructor 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="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-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-512-text"></path></svg><span>constructor</span></a>
|
39
39
|
</div></section>
|
40
40
|
<section class="tsd-index-section">
|
41
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
42
|
+
<div class="tsd-index-list"><a href="UserSecurityIdentityBuilder.html#securityProvider" 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>security<wbr/>Provider</span></a>
|
43
|
+
<a href="UserSecurityIdentityBuilder.html#user" 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>user</span></a>
|
44
|
+
</div></section>
|
45
|
+
<section class="tsd-index-section">
|
41
46
|
<h3 class="tsd-index-heading">Methods</h3>
|
42
47
|
<div class="tsd-index-list"><a href="UserSecurityIdentityBuilder.html#build" 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"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>build</span></a>
|
43
48
|
</div></section></div></details></section></section>
|
@@ -59,7 +64,19 @@
|
|
59
64
|
<h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Email Security Provider'</span></h5></li></ul></div>
|
60
65
|
<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
66
|
<ul>
|
62
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
67
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
|
68
|
+
<section class="tsd-panel-group tsd-member-group">
|
69
|
+
<h2>Properties</h2>
|
70
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
|
71
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>security<wbr/>Provider</span><a href="#securityProvider" 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>
|
72
|
+
<div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Email Security Provider'</span></div><aside class="tsd-sources">
|
73
|
+
<ul>
|
74
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
|
75
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="user" class="tsd-anchor"></a>
|
76
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
77
|
+
<div class="tsd-signature">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
78
|
+
<ul>
|
79
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
|
63
80
|
<section class="tsd-panel-group tsd-member-group">
|
64
81
|
<h2>Methods</h2>
|
65
82
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
@@ -73,7 +90,7 @@
|
|
73
90
|
<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
91
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
75
92
|
<ul>
|
76
|
-
<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/b427571/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
|
77
94
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
78
95
|
<div class="tsd-navigation settings">
|
79
96
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -101,6 +118,8 @@
|
|
101
118
|
<li class="current tsd-kind-class"><a href="UserSecurityIdentityBuilder.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>User<wbr/>Security<wbr/>Identity<wbr/>Builder</span></a>
|
102
119
|
<ul>
|
103
120
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="UserSecurityIdentityBuilder.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>
|
121
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="UserSecurityIdentityBuilder.html#securityProvider" 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>security<wbr/>Provider</a></li>
|
122
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="UserSecurityIdentityBuilder.html#user" 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>user</a></li>
|
104
123
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="UserSecurityIdentityBuilder.html#build" 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>build</a></li></ul></li></ul></nav></div></div>
|
105
124
|
<div class="container tsd-generator">
|
106
125
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
@@ -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/b427571/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">
|
@@ -38,6 +38,11 @@
|
|
38
38
|
<div class="tsd-index-list"><a href="VirtualGroupSecurityIdentityBuilder.html#constructor" class="tsd-index-link tsd-kind-constructor 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="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-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-512-text"></path></svg><span>constructor</span></a>
|
39
39
|
</div></section>
|
40
40
|
<section class="tsd-index-section">
|
41
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
42
|
+
<div class="tsd-index-list"><a href="VirtualGroupSecurityIdentityBuilder.html#securityProvider" 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>security<wbr/>Provider?</span></a>
|
43
|
+
<a href="VirtualGroupSecurityIdentityBuilder.html#virtualGroup" 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>virtual<wbr/>Group</span></a>
|
44
|
+
</div></section>
|
45
|
+
<section class="tsd-index-section">
|
41
46
|
<h3 class="tsd-index-heading">Methods</h3>
|
42
47
|
<div class="tsd-index-list"><a href="VirtualGroupSecurityIdentityBuilder.html#build" 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"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>build</span></a>
|
43
48
|
</div></section></div></details></section></section>
|
@@ -59,7 +64,19 @@
|
|
59
64
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
60
65
|
<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
66
|
<ul>
|
62
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
67
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
|
68
|
+
<section class="tsd-panel-group tsd-member-group">
|
69
|
+
<h2>Properties</h2>
|
70
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
|
71
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" 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>
|
72
|
+
<div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
73
|
+
<ul>
|
74
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
|
75
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="virtualGroup" class="tsd-anchor"></a>
|
76
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>virtual<wbr/>Group</span><a href="#virtualGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
77
|
+
<div class="tsd-signature">virtual<wbr/>Group<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
78
|
+
<ul>
|
79
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
|
63
80
|
<section class="tsd-panel-group tsd-member-group">
|
64
81
|
<h2>Methods</h2>
|
65
82
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
@@ -73,7 +90,7 @@
|
|
73
90
|
<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
91
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
75
92
|
<ul>
|
76
|
-
<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/b427571/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
|
77
94
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
78
95
|
<div class="tsd-navigation settings">
|
79
96
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -101,6 +118,8 @@
|
|
101
118
|
<li class="current tsd-kind-class"><a href="VirtualGroupSecurityIdentityBuilder.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>Virtual<wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder</span></a>
|
102
119
|
<ul>
|
103
120
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="VirtualGroupSecurityIdentityBuilder.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>
|
121
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="VirtualGroupSecurityIdentityBuilder.html#securityProvider" 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>security<wbr/>Provider?</a></li>
|
122
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="VirtualGroupSecurityIdentityBuilder.html#virtualGroup" 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>virtual<wbr/>Group</a></li>
|
104
123
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="VirtualGroupSecurityIdentityBuilder.html#build" 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>build</a></li></ul></li></ul></nav></div></div>
|
105
124
|
<div class="container tsd-generator">
|
106
125
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
@@ -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/b427571/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/b427571/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/b427571/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">
|
@@ -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/b427571/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/b427571/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/b427571/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">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">InvalidPermanentId</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/b427571/src/errors/fieldErrors.ts#L27">src/errors/fieldErrors.ts:27</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.InvalidPermanentId.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidPermanentId</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/b427571/src/errors/fieldErrors.ts#L29">src/errors/fieldErrors.ts:29</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"> = 'Invalid permanentId field 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/b427571/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</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">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">NotAFileError</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/b427571/src/errors/validatorErrors.ts#L4">src/errors/validatorErrors.ts:4</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.NotAFileError.html" class="tsd-signature-type" data-tsd-kind="Class">NotAFileError</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/b427571/src/errors/validatorErrors.ts#L6">src/errors/validatorErrors.ts:6</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"> = 'Not A File 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/b427571/src/errors/validatorErrors.ts#L5">src/errors/validatorErrors.ts:5</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">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">NotAJsonFileError</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/b427571/src/errors/validatorErrors.ts#L10">src/errors/validatorErrors.ts:10</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.NotAJsonFileError.html" class="tsd-signature-type" data-tsd-kind="Class">NotAJsonFileError</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/b427571/src/errors/validatorErrors.ts#L12">src/errors/validatorErrors.ts:12</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"> = 'Not A JSON File 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/b427571/src/errors/validatorErrors.ts#L11">src/errors/validatorErrors.ts:11</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">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">PrivilegeError</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/b427571/src/errors/privilegeError.ts#L3">src/errors/privilegeError.ts:3</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.PrivilegeError.html" class="tsd-signature-type" data-tsd-kind="Class">PrivilegeError</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/b427571/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</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"><a id="message" class="tsd-anchor"></a>
|
@@ -66,13 +66,13 @@
|
|
66
66
|
<div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
67
67
|
<p>Inherited from PushApiClientBaseError.message</p>
|
68
68
|
<ul>
|
69
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
69
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/errors/privilegeError.ts#L5">src/errors/privilegeError.ts:5</a></li></ul></aside></section>
|
70
70
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
|
71
71
|
<h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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>
|
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"> = 'Privilege 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/b427571/src/errors/privilegeError.ts#L4">src/errors/privilegeError.ts:4</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">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">UnsupportedAttribute</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/b427571/src/errors/validatorErrors.ts#L31">src/errors/validatorErrors.ts:31</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.UnsupportedAttribute.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedAttribute</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/b427571/src/errors/validatorErrors.ts#L33">src/errors/validatorErrors.ts:33</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"> = 'Unsupported Attribute 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/b427571/src/errors/validatorErrors.ts#L32">src/errors/validatorErrors.ts:32</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">
|
@@ -21,7 +21,7 @@
|
|
21
21
|
<ul class="tsd-hierarchy">
|
22
22
|
<li><span class="target">UnsupportedFieldError</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/b427571/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</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">
|
@@ -64,7 +64,7 @@
|
|
64
64
|
<h4 class="tsd-returns-title">Returns <a href="errors.UnsupportedFieldError.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedFieldError</a></h4><aside class="tsd-sources">
|
65
65
|
<p>Overrides PushApiClientBaseError.constructor</p>
|
66
66
|
<ul>
|
67
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
67
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
|
68
68
|
<section class="tsd-panel-group tsd-member-group">
|
69
69
|
<h2>Properties</h2>
|
70
70
|
<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>
|
@@ -78,7 +78,7 @@
|
|
78
78
|
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Unsupported field Error'</span></div><aside class="tsd-sources">
|
79
79
|
<p>Overrides PushApiClientBaseError.name</p>
|
80
80
|
<ul>
|
81
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
81
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
|
82
82
|
<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>
|
83
83
|
<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>
|
84
84
|
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
@@ -89,12 +89,12 @@
|
|
89
89
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>unsupported<wbr/>Fields</span><a href="#unsupportedFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
90
90
|
<div class="tsd-signature">unsupported<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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></div><aside class="tsd-sources">
|
91
91
|
<ul>
|
92
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
92
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
|
93
93
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyFieldNameReplacer" class="tsd-anchor"></a>
|
94
94
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>empty<wbr/>Field<wbr/>Name<wbr/>Replacer</span><a href="#emptyFieldNameReplacer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
95
95
|
<div class="tsd-signature">empty<wbr/>Field<wbr/>Name<wbr/>Replacer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = '<empty field name>'</span></div><aside class="tsd-sources">
|
96
96
|
<ul>
|
97
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
97
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
|
98
98
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
|
99
99
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" 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>
|
100
100
|
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
|
@@ -135,7 +135,7 @@
|
|
135
135
|
<li class="tsd-description">
|
136
136
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
137
137
|
<ul>
|
138
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
138
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
|
139
139
|
<section class="tsd-panel-group tsd-member-group">
|
140
140
|
<h2>Methods</h2>
|
141
141
|
<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>
|
@@ -14,7 +14,7 @@
|
|
14
14
|
<li><a href="PlatformEnvironment.html">PlatformEnvironment</a></li></ul>
|
15
15
|
<h1>Enumeration PlatformEnvironment</h1></div><aside class="tsd-sources">
|
16
16
|
<ul>
|
17
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
17
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
|
18
18
|
<section class="tsd-panel-group tsd-index-group">
|
19
19
|
<section class="tsd-panel tsd-index-panel">
|
20
20
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -33,22 +33,22 @@
|
|
33
33
|
<h3 class="tsd-anchor-link"><span>Dev</span><a href="#Dev" 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>
|
34
34
|
<div class="tsd-signature">Dev<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"dev"</span></div><aside class="tsd-sources">
|
35
35
|
<ul>
|
36
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
36
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
|
37
37
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Hipaa" class="tsd-anchor"></a>
|
38
38
|
<h3 class="tsd-anchor-link"><span>Hipaa</span><a href="#Hipaa" 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>
|
39
39
|
<div class="tsd-signature">Hipaa<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"hipaa"</span></div><aside class="tsd-sources">
|
40
40
|
<ul>
|
41
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
41
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
|
42
42
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Prod" class="tsd-anchor"></a>
|
43
43
|
<h3 class="tsd-anchor-link"><span>Prod</span><a href="#Prod" 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>
|
44
44
|
<div class="tsd-signature">Prod<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"prod"</span></div><aside class="tsd-sources">
|
45
45
|
<ul>
|
46
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
46
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
|
47
47
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stg" class="tsd-anchor"></a>
|
48
48
|
<h3 class="tsd-anchor-link"><span>Stg</span><a href="#Stg" 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>
|
49
49
|
<div class="tsd-signature">Stg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"stg"</span></div><aside class="tsd-sources">
|
50
50
|
<ul>
|
51
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
51
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
|
52
52
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
53
53
|
<div class="tsd-navigation settings">
|
54
54
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -26,7 +26,7 @@
|
|
26
26
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
|
27
27
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
28
28
|
<ul>
|
29
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
29
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
|
30
30
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
31
31
|
<div class="tsd-navigation settings">
|
32
32
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
@@ -18,7 +18,7 @@
|
|
18
18
|
<ul class="tsd-hierarchy">
|
19
19
|
<li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
|
20
20
|
<ul>
|
21
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
21
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
|
22
22
|
<section class="tsd-panel-group tsd-index-group">
|
23
23
|
<section class="tsd-panel tsd-index-panel">
|
24
24
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
@@ -35,12 +35,12 @@
|
|
35
35
|
<h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update</span><a href="#addOrUpdate" 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>
|
36
36
|
<div class="tsd-signature">add<wbr/>Or<wbr/>Update<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
37
37
|
<ul>
|
38
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
38
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
|
39
39
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
|
40
40
|
<h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" 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>
|
41
|
-
<div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">
|
41
|
+
<div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
42
42
|
<ul>
|
43
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
43
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
|
44
44
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
45
45
|
<div class="tsd-navigation settings">
|
46
46
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|