@coveo/push-api-client 2.5.22 → 2.5.23

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 (37) hide show
  1. package/dist/docs/assets/search.js +1 -1
  2. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  3. package/dist/docs/classes/CatalogSource.html +31 -17
  4. package/dist/docs/classes/DocumentBuilder.html +40 -33
  5. package/dist/docs/classes/FieldAnalyser.html +18 -11
  6. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +22 -3
  7. package/dist/docs/classes/PushSource.html +39 -25
  8. package/dist/docs/classes/UserSecurityIdentityBuilder.html +22 -3
  9. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +22 -3
  10. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  11. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  12. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  13. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  14. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  15. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  16. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  17. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  18. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  19. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  20. package/dist/docs/interfaces/BatchUpdateDocuments.html +4 -4
  21. package/dist/docs/interfaces/Document.html +16 -16
  22. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  23. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  24. package/dist/docs/interfaces/UploadBatchCallbackData.html +4 -4
  25. package/dist/docs/modules/errors.html +1 -1
  26. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  27. package/dist/docs/types/CompressionType.html +1 -1
  28. package/dist/docs/types/FailedUploadCallback.html +1 -1
  29. package/dist/docs/types/Metadata.html +1 -1
  30. package/dist/docs/types/MetadataValue.html +1 -1
  31. package/dist/docs/types/PlatformUrlOptions.html +2 -2
  32. package/dist/docs/types/SecurityIdentityType.html +1 -1
  33. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  34. package/dist/docs/types/Transformer.html +1 -1
  35. package/dist/docs/variables/BuiltInTransformers.html +2 -2
  36. package/dist/docs/variables/Source.html +1 -1
  37. package/package.json +6 -6
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/c460dec/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/e2f617b/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">
@@ -36,6 +36,7 @@
36
36
  <div class="tsd-index-list"><a href="FieldAnalyser.html#existingFields" 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>existing<wbr/>Fields</span></a>
37
37
  <a href="FieldAnalyser.html#inconsistencies" 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>inconsistencies</span></a>
38
38
  <a href="FieldAnalyser.html#missingFields" 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>missing<wbr/>Fields</span></a>
39
+ <a href="FieldAnalyser.html#platformClient" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>platform<wbr/>Client</span></a>
39
40
  </div></section>
40
41
  <section class="tsd-index-section">
41
42
  <h3 class="tsd-index-heading">Methods</h3>
@@ -60,24 +61,29 @@
60
61
  <h5>platformClient: <span class="tsd-signature-type">PlatformClient</span></h5></li></ul></div>
61
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">
62
63
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
64
65
  <section class="tsd-panel-group tsd-member-group">
65
66
  <h2>Properties</h2>
66
67
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="existingFields" class="tsd-anchor"></a>
67
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>
68
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">
69
70
  <ul>
70
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
71
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="inconsistencies" class="tsd-anchor"></a>
72
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>
73
74
  <div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
74
75
  <ul>
75
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
76
77
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="missingFields" class="tsd-anchor"></a>
77
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>
78
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">
79
80
  <ul>
80
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section></section>
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>
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
+ <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
+ <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
+ <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>
81
87
  <section class="tsd-panel-group tsd-member-group">
82
88
  <h2>Methods</h2>
83
89
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
@@ -96,7 +102,7 @@ This method can be called as many time as needed as it will take into considerat
96
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>
97
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">
98
104
  <ul>
99
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
100
106
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensureExistingFields" class="tsd-anchor"></a>
101
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>
102
108
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -104,7 +110,7 @@ This method can be called as many time as needed as it will take into considerat
104
110
  <li class="tsd-description">
105
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">
106
112
  <ul>
107
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
108
114
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensurePermanentId" class="tsd-anchor"></a>
109
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>
110
116
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -117,7 +123,7 @@ This method can be called as many time as needed as it will take into considerat
117
123
  <h5>fieldStore: <span class="tsd-signature-type">FieldStore</span></h5></li></ul></div>
118
124
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
119
125
  <ul>
120
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
121
127
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="removeInconsistentFields" class="tsd-anchor"></a>
122
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>
123
129
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -125,7 +131,7 @@ This method can be called as many time as needed as it will take into considerat
125
131
  <li class="tsd-description">
126
132
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
127
133
  <ul>
128
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
129
135
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="report" class="tsd-anchor"></a>
130
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>
131
137
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -137,7 +143,7 @@ This method can be called as many time as needed as it will take into considerat
137
143
  </div>
138
144
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4><aside class="tsd-sources">
139
145
  <ul>
140
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
141
147
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="storeMetadata" class="tsd-anchor"></a>
142
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>
143
149
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -152,7 +158,7 @@ This method can be called as many time as needed as it will take into considerat
152
158
  <h5>metadataValue: <a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a></h5></li></ul></div>
153
159
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
154
160
  <ul>
155
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
156
162
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
157
163
  <div class="tsd-navigation settings">
158
164
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -183,6 +189,7 @@ This method can be called as many time as needed as it will take into considerat
183
189
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#existingFields" 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>existing<wbr/>Fields</a></li>
184
190
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#inconsistencies" 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>inconsistencies</a></li>
185
191
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#missingFields" 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>missing<wbr/>Fields</a></li>
192
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#platformClient" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>platform<wbr/>Client</a></li>
186
193
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#add" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add</a></li>
187
194
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#ensureExistingFields" 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>ensure<wbr/>Existing<wbr/>Fields</a></li>
188
195
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#ensurePermanentId" 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>ensure<wbr/>Permanent<wbr/>Id</a></li>
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/c460dec/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/e2f617b/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">
@@ -38,6 +38,11 @@
38
38
  <div class="tsd-index-list"><a href="GroupSecurityIdentityBuilder.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="GroupSecurityIdentityBuilder.html#group" 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>group</span></a>
43
+ <a href="GroupSecurityIdentityBuilder.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"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>security<wbr/>Provider?</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="GroupSecurityIdentityBuilder.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="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
61
66
  <ul>
62
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</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="group" class="tsd-anchor"></a>
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
+ <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
+ <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>
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
+ <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
+ <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
+ <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>
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/c460dec/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/e2f617b/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</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="GroupSecurityIdentityBuilder.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>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="GroupSecurityIdentityBuilder.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="GroupSecurityIdentityBuilder.html#group" 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>group</a></li>
122
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="GroupSecurityIdentityBuilder.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>
104
123
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="GroupSecurityIdentityBuilder.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>
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/c460dec/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/e2f617b/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">
@@ -34,7 +34,9 @@
34
34
  </div></section>
35
35
  <section class="tsd-index-section">
36
36
  <h3 class="tsd-index-heading">Properties</h3>
37
- <div class="tsd-index-list"><a href="PushSource.html#options" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>options</span></a>
37
+ <div class="tsd-index-list"><a href="PushSource.html#apikey" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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>apikey</span></a>
38
+ <a href="PushSource.html#options" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>options</span></a>
39
+ <a href="PushSource.html#organizationid" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>organizationid</span></a>
38
40
  <a href="PushSource.html#platformClient" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>platform<wbr/>Client</span></a>
39
41
  <a href="PushSource.html#defaultOptions" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Options</span></a>
40
42
  </div></section>
@@ -83,24 +85,34 @@
83
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>
84
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">
85
87
  <ul>
86
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
87
89
  <section class="tsd-panel-group tsd-member-group">
88
90
  <h2>Properties</h2>
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
+ <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
+ <div class="tsd-signature">apikey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
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>
89
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
90
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>
91
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">
92
99
  <ul>
93
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
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
+ <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
+ <div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
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>
94
106
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
95
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>
96
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">
97
109
  <ul>
98
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
99
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
100
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>
101
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">
102
114
  <ul>
103
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
104
116
  <section class="tsd-panel-group tsd-member-group">
105
117
  <h2>Accessors</h2>
106
118
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
@@ -110,7 +122,7 @@
110
122
  <li class="tsd-description">
111
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">
112
124
  <ul>
113
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
114
126
  <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
115
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>
116
128
  <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@@ -118,7 +130,7 @@
118
130
  <li class="tsd-description">
119
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
120
132
  <ul>
121
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
122
134
  <section class="tsd-panel-group tsd-member-group">
123
135
  <h2>Methods</h2>
124
136
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
@@ -140,7 +152,7 @@
140
152
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
141
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">
142
154
  <ul>
143
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
144
156
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
145
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>
146
158
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -160,7 +172,7 @@
160
172
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
161
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">
162
174
  <ul>
163
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
164
176
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
165
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>
166
178
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -183,11 +195,11 @@
183
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>
184
196
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
185
197
  <ul>
186
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
187
199
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
188
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>
189
201
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
190
- <li class="tsd-signature tsd-anchor-link" id="create.create-1">create<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sourceVisibility<span class="tsd-signature-symbol">: </span><a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><a href="#create.create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
202
+ <li class="tsd-signature tsd-anchor-link" id="create.create-1">create<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sourceVisibility<span class="tsd-signature-symbol">: </span><a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&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><a href="#create.create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
191
203
  <li class="tsd-description">
192
204
  <div class="tsd-comment tsd-typography"><p>Create a new push source</p>
193
205
 
@@ -203,9 +215,9 @@
203
215
  <h5>sourceVisibility: <a href="../enums/SourceVisibility.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SourceVisibility</a></h5>
204
216
  <div class="tsd-comment tsd-typography"><p>The security option that should be applied to the content of the source. See <a href="https://docs.coveo.com/en/1779">Content Security</a>.</p>
205
217
  </div></li></ul></div>
206
- <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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
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">
207
219
  <ul>
208
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
209
221
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
210
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>
211
223
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -218,7 +230,7 @@
218
230
  <h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
219
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">
220
232
  <ul>
221
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
222
234
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
223
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>
224
236
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -237,7 +249,7 @@
237
249
  <h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
238
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">
239
251
  <ul>
240
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
241
253
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
242
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>
243
255
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -256,7 +268,7 @@
256
268
  <h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
257
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">
258
270
  <ul>
259
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
260
272
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
261
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>
262
274
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -276,7 +288,7 @@
276
288
  <h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
277
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">
278
290
  <ul>
279
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
280
292
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
281
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>
282
294
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -294,7 +306,7 @@
294
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>
295
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">
296
308
  <ul>
297
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
298
310
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
299
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>
300
312
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -313,7 +325,7 @@
313
325
  <h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
314
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">
315
327
  <ul>
316
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
317
329
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
318
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>
319
331
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -332,7 +344,7 @@
332
344
  <h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
333
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">
334
346
  <ul>
335
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
336
348
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
337
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>
338
350
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -345,7 +357,7 @@
345
357
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
346
358
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
347
359
  <ul>
348
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
349
361
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
350
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>
351
363
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -364,7 +376,7 @@
364
376
  <h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
365
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">
366
378
  <ul>
367
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
368
380
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
369
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>
370
382
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -382,7 +394,7 @@
382
394
  <h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
383
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">
384
396
  <ul>
385
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
386
398
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
387
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>
388
400
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -395,7 +407,7 @@
395
407
  <h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
396
408
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
397
409
  <ul>
398
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/c460dec/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/e2f617b/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
399
411
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
400
412
  <div class="tsd-navigation settings">
401
413
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -423,7 +435,9 @@
423
435
  <li class="current tsd-kind-class"><a href="PushSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Push<wbr/>Source</span></a>
424
436
  <ul>
425
437
  <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PushSource.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
438
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#apikey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>apikey</a></li>
426
439
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>options</a></li>
440
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#organizationid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>organizationid</a></li>
427
441
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="PushSource.html#platformClient" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>platform<wbr/>Client</a></li>
428
442
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#defaultOptions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>default<wbr/>Options</a></li>
429
443
  <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a href="PushSource.html#documentsAxiosConfig" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>documents<wbr/>Axios<wbr/>Config</a></li>