@coveo/push-api-client 2.5.23 → 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.
Files changed (36) hide show
  1. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  2. package/dist/docs/classes/CatalogSource.html +16 -16
  3. package/dist/docs/classes/DocumentBuilder.html +28 -28
  4. package/dist/docs/classes/FieldAnalyser.html +12 -12
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  6. package/dist/docs/classes/PushSource.html +24 -24
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  10. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  11. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  12. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  13. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  14. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  15. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  16. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  17. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  18. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  19. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  20. package/dist/docs/interfaces/Document.html +14 -14
  21. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  22. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  23. package/dist/docs/interfaces/UploadBatchCallbackData.html +4 -4
  24. package/dist/docs/modules/errors.html +1 -1
  25. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  26. package/dist/docs/types/CompressionType.html +1 -1
  27. package/dist/docs/types/FailedUploadCallback.html +1 -1
  28. package/dist/docs/types/Metadata.html +1 -1
  29. package/dist/docs/types/MetadataValue.html +1 -1
  30. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  31. package/dist/docs/types/SecurityIdentityType.html +1 -1
  32. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  33. package/dist/docs/types/Transformer.html +1 -1
  34. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  35. package/dist/docs/variables/Source.html +1 -1
  36. package/package.json +1 -1
package/dist/docs/classes/FieldAnalyser.html CHANGED
@@ -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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L18">src/fieldAnalyser/fieldAnalyser.ts:18</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/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">
@@ -61,29 +61,29 @@
61
61
  <h5>platformClient: <span class="tsd-signature-type">PlatformClient</span></h5></li></ul></div>
62
62
  <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">
63
63
  <ul>
64
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
64
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
65
65
  <section class="tsd-panel-group tsd-member-group">
66
66
  <h2>Properties</h2>
67
67
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="existingFields" class="tsd-anchor"></a>
68
68
  <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>
69
69
  <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">
70
70
  <ul>
71
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
71
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="inconsistencies" class="tsd-anchor"></a>
73
73
  <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>
74
74
  <div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="missingFields" class="tsd-anchor"></a>
78
78
  <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>
79
79
  <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">
80
80
  <ul>
81
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section>
81
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section>
82
82
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
83
83
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>platform<wbr/>Client</span><a href="#platformClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
84
84
  <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">
85
85
  <ul>
86
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section></section>
86
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section></section>
87
87
  <section class="tsd-panel-group tsd-member-group">
88
88
  <h2>Methods</h2>
89
89
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
@@ -102,7 +102,7 @@ This method can be called as many time as needed as it will take into considerat
102
102
  <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>
103
103
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
105
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
106
106
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensureExistingFields" class="tsd-anchor"></a>
107
107
  <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>
108
108
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -110,7 +110,7 @@ This method can be called as many time as needed as it will take into considerat
110
110
  <li class="tsd-description">
111
111
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
112
112
  <ul>
113
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
113
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
114
114
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensurePermanentId" class="tsd-anchor"></a>
115
115
  <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>
116
116
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -123,7 +123,7 @@ This method can be called as many time as needed as it will take into considerat
123
123
  <h5>fieldStore: <span class="tsd-signature-type">FieldStore</span></h5></li></ul></div>
124
124
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
125
125
  <ul>
126
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
126
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
127
127
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="removeInconsistentFields" class="tsd-anchor"></a>
128
128
  <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>
129
129
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -131,7 +131,7 @@ This method can be called as many time as needed as it will take into considerat
131
131
  <li class="tsd-description">
132
132
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
133
133
  <ul>
134
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
134
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
135
135
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="report" class="tsd-anchor"></a>
136
136
  <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>
137
137
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -143,7 +143,7 @@ This method can be called as many time as needed as it will take into considerat
143
143
  </div>
144
144
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4><aside class="tsd-sources">
145
145
  <ul>
146
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
146
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
147
147
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="storeMetadata" class="tsd-anchor"></a>
148
148
  <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>
149
149
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -158,7 +158,7 @@ This method can be called as many time as needed as it will take into considerat
158
158
  <h5>metadataValue: <a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a></h5></li></ul></div>
159
159
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
160
160
  <ul>
161
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
161
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
162
162
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
163
163
  <div class="tsd-navigation settings">
164
164
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/GroupSecurityIdentityBuilder.html CHANGED
@@ -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/e2f617b/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
30
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/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">
@@ -64,19 +64,19 @@
64
64
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
65
65
  <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">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
67
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</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-private"><a id="group" class="tsd-anchor"></a>
71
71
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>group</span><a href="#group" 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">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">
73
73
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</a></li></ul></aside></section>
74
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</a></li></ul></aside></section>
75
75
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
76
76
  <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>
77
77
  <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">
78
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</a></li></ul></aside></section></section>
79
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</a></li></ul></aside></section></section>
80
80
  <section class="tsd-panel-group tsd-member-group">
81
81
  <h2>Methods</h2>
82
82
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +90,7 @@
90
90
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><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">
91
91
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
93
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
94
94
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
95
  <div class="tsd-navigation settings">
96
96
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/PushSource.html CHANGED
@@ -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/e2f617b/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside>
25
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/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">
@@ -85,34 +85,34 @@
85
85
  <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>
86
86
  <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">
87
87
  <ul>
88
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
88
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
89
89
  <section class="tsd-panel-group tsd-member-group">
90
90
  <h2>Properties</h2>
91
91
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
92
92
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>apikey</span><a href="#apikey" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
93
93
  <div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
94
94
  <ul>
95
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
95
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
96
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
97
97
  <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>
98
98
  <div class="tsd-signature">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
99
99
  <ul>
100
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
100
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
101
101
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
102
102
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>organizationid</span><a href="#organizationid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
103
103
  <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
105
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
106
106
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
107
107
  <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>
108
108
  <div class="tsd-signature">platform<wbr/>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformClient</span></div><aside class="tsd-sources">
109
109
  <ul>
110
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
110
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
111
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
112
112
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>default<wbr/>Options</span><a href="#defaultOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
113
113
  <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">&lt;</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
114
114
  <ul>
115
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
115
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
116
116
  <section class="tsd-panel-group tsd-member-group">
117
117
  <h2>Accessors</h2>
118
118
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
@@ -122,7 +122,7 @@
122
122
  <li class="tsd-description">
123
123
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
124
124
  <ul>
125
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
125
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
126
126
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
127
127
  <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>
128
128
  <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@@ -130,7 +130,7 @@
130
130
  <li class="tsd-description">
131
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
132
132
  <ul>
133
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
133
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
134
134
  <section class="tsd-panel-group tsd-member-group">
135
135
  <h2>Methods</h2>
136
136
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
@@ -152,7 +152,7 @@
152
152
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
153
153
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
154
154
  <ul>
155
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
155
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
156
156
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
157
157
  <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>
158
158
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -172,7 +172,7 @@
172
172
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
173
173
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
174
174
  <ul>
175
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
175
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
176
176
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
177
177
  <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>
178
178
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -195,7 +195,7 @@
195
195
  <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>
196
196
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
197
197
  <ul>
198
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
198
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
199
199
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
200
200
  <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>
201
201
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -217,7 +217,7 @@
217
217
  </div></li></ul></div>
218
218
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
219
219
  <ul>
220
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
220
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
221
221
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
222
222
  <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>
223
223
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -230,7 +230,7 @@
230
230
  <h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
231
231
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
232
232
  <ul>
233
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
233
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
234
234
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
235
235
  <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>
236
236
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -249,7 +249,7 @@
249
249
  <h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
250
250
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
251
251
  <ul>
252
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
252
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
253
253
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
254
254
  <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>
255
255
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -268,7 +268,7 @@
268
268
  <h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
269
269
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
270
270
  <ul>
271
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
271
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
272
272
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
273
273
  <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>
274
274
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -288,7 +288,7 @@
288
288
  <h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
289
289
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
290
290
  <ul>
291
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
291
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
292
292
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
293
293
  <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>
294
294
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -306,7 +306,7 @@
306
306
  <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>
307
307
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
308
308
  <ul>
309
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
309
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
310
310
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
311
311
  <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>
312
312
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -325,7 +325,7 @@
325
325
  <h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
326
326
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
327
327
  <ul>
328
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
328
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
329
329
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
330
330
  <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>
331
331
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -344,7 +344,7 @@
344
344
  <h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
345
345
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
346
346
  <ul>
347
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
347
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
348
348
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
349
349
  <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>
350
350
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -357,7 +357,7 @@
357
357
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
358
358
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
359
359
  <ul>
360
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
360
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
361
361
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
362
362
  <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>
363
363
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -376,7 +376,7 @@
376
376
  <h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
377
377
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
378
378
  <ul>
379
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
379
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
380
380
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
381
381
  <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>
382
382
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -394,7 +394,7 @@
394
394
  <h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
395
395
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
396
396
  <ul>
397
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
397
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
398
398
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
399
399
  <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>
400
400
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -407,7 +407,7 @@
407
407
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
408
408
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
409
409
  <ul>
410
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
410
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/b427571/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
411
411
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
412
412
  <div class="tsd-navigation settings">
413
413
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/UserSecurityIdentityBuilder.html CHANGED
@@ -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/e2f617b/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
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">
@@ -64,19 +64,19 @@
64
64
  <h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Email Security Provider&#39;</span></h5></li></ul></div>
65
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">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
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
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-private"><a id="securityProvider" class="tsd-anchor"></a>
71
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
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"> = &#39;Email Security Provider&#39;</span></div><aside class="tsd-sources">
73
73
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
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
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
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
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
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
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>
80
80
  <section class="tsd-panel-group tsd-member-group">
81
81
  <h2>Methods</h2>
82
82
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +90,7 @@
90
90
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><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">
91
91
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
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>
94
94
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
95
  <div class="tsd-navigation settings">
96
96
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html CHANGED
@@ -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/e2f617b/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
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">
@@ -64,19 +64,19 @@
64
64
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
65
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">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
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
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-private"><a id="securityProvider" class="tsd-anchor"></a>
71
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
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
73
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
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
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
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
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
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
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>
80
80
  <section class="tsd-panel-group tsd-member-group">
81
81
  <h2>Methods</h2>
82
82
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
@@ -90,7 +90,7 @@
90
90
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><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">
91
91
  <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
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>
94
94
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95
95
  <div class="tsd-navigation settings">
96
96
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.FieldTypeInconsistencyError.html CHANGED
@@ -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/e2f617b/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
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/e2f617b/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
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"> = &#39;Field Type Inconsistency Error&#39;</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/e2f617b/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
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">