@coveo/push-api-client 1.0.0 → 1.1.4

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 (51) hide show
  1. package/README.md +41 -2
  2. package/dist/definitions/document.d.ts +1 -1
  3. package/dist/docs/.nojekyll +1 -0
  4. package/dist/docs/assets/highlight.css +71 -0
  5. package/dist/docs/assets/icons.css +1043 -0
  6. package/dist/docs/assets/{images/icons.png → icons.png} +0 -0
  7. package/dist/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  8. package/dist/docs/assets/main.js +52 -0
  9. package/dist/docs/assets/{js/search.js → search.js} +1 -1
  10. package/dist/docs/assets/style.css +1384 -0
  11. package/dist/docs/assets/{images/widgets.png → widgets.png} +0 -0
  12. package/dist/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  13. package/dist/docs/classes/AnySecurityIdentityBuilder.html +12 -0
  14. package/dist/docs/classes/DocumentBuilder.html +37 -0
  15. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +10 -0
  16. package/dist/docs/classes/Source.html +34 -0
  17. package/dist/docs/classes/UserSecurityIdentityBuilder.html +10 -0
  18. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +10 -0
  19. package/dist/docs/enums/Environment.html +1 -0
  20. package/dist/docs/enums/SourceVisibility.html +1 -0
  21. package/dist/docs/index.html +38 -156
  22. package/dist/docs/interfaces/BatchUpdateDocuments.html +1 -0
  23. package/dist/docs/interfaces/Document.html +67 -0
  24. package/dist/docs/interfaces/SecurityIdentity.html +22 -0
  25. package/dist/docs/interfaces/SecurityIdentityBuilder.html +3 -0
  26. package/dist/docs/modules.html +3 -240
  27. package/dist/documentBuilder.js +10 -5
  28. package/dist/documentBuilder.js.map +1 -1
  29. package/dist/documentBuilder.spec.js +34 -0
  30. package/dist/documentBuilder.spec.js.map +1 -1
  31. package/dist/index.js +2 -2
  32. package/dist/index.js.map +1 -1
  33. package/dist/securityIdentityBuilder.js.map +1 -1
  34. package/dist/source.spec.js +1 -1
  35. package/dist/source.spec.js.map +1 -1
  36. package/package.json +20 -19
  37. package/CHANGELOG.md +0 -52
  38. package/dist/docs/assets/css/main.css +0 -2660
  39. package/dist/docs/assets/js/main.js +0 -248
  40. package/dist/docs/classes/anysecurityidentitybuilder.html +0 -297
  41. package/dist/docs/classes/documentbuilder.html +0 -949
  42. package/dist/docs/classes/groupsecurityidentitybuilder.html +0 -273
  43. package/dist/docs/classes/source.html +0 -897
  44. package/dist/docs/classes/usersecurityidentitybuilder.html +0 -273
  45. package/dist/docs/classes/virtualgroupsecurityidentitybuilder.html +0 -273
  46. package/dist/docs/enums/environment.html +0 -234
  47. package/dist/docs/enums/sourcevisibility.html +0 -220
  48. package/dist/docs/interfaces/batchupdatedocuments.html +0 -214
  49. package/dist/docs/interfaces/document.html +0 -518
  50. package/dist/docs/interfaces/securityidentity.html +0 -263
  51. package/dist/docs/interfaces/securityidentitybuilder.html +0 -223
package/dist/docs/classes/anysecurityidentitybuilder.html DELETED
@@ -1,297 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>AnySecurityIdentityBuilder | @coveo/push-api-client</title>
7
- <meta name="description" content="Documentation for @coveo/push-api-client">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@coveo/push-api-client</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@coveo/push-api-client</a>
56
- </li>
57
- <li>
58
- <a href="anysecurityidentitybuilder.html">AnySecurityIdentityBuilder</a>
59
- </li>
60
- </ul>
61
- <h1>Class AnySecurityIdentityBuilder</h1>
62
- </div>
63
- </div>
64
- </header>
65
- <div class="container container-main">
66
- <div class="row">
67
- <div class="col-8 col-content">
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <div class="lead">
71
- <p>Build any <a href="../modules.html#securityidentitytype">SecurityIdentityType</a>.</p>
72
- </div>
73
- <p>Instead of using this class directly, use one of:</p>
74
- <ul>
75
- <li><a href="usersecurityidentitybuilder.html">UserSecurityIdentityBuilder</a></li>
76
- <li><a href="groupsecurityidentitybuilder.html">GroupSecurityIdentityBuilder</a></li>
77
- <li><a href="virtualgroupsecurityidentitybuilder.html">VirtualGroupSecurityIdentityBuilder</a></li>
78
- </ul>
79
- </div>
80
- </section>
81
- <section class="tsd-panel tsd-hierarchy">
82
- <h3>Hierarchy</h3>
83
- <ul class="tsd-hierarchy">
84
- <li>
85
- <span class="target">AnySecurityIdentityBuilder</span>
86
- </li>
87
- </ul>
88
- </section>
89
- <section class="tsd-panel">
90
- <h3>Implements</h3>
91
- <ul class="tsd-hierarchy">
92
- <li><a href="../interfaces/securityidentitybuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li>
93
- </ul>
94
- </section>
95
- <section class="tsd-panel-group tsd-index-group">
96
- <h2>Index</h2>
97
- <section class="tsd-panel tsd-index-panel">
98
- <div class="tsd-index-content">
99
- <section class="tsd-index-section ">
100
- <h3>Constructors</h3>
101
- <ul class="tsd-index-list">
102
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="anysecurityidentitybuilder.html#constructor" class="tsd-kind-icon">constructor</a></li>
103
- </ul>
104
- </section>
105
- <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
106
- <h3>Properties</h3>
107
- <ul class="tsd-index-list">
108
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="anysecurityidentitybuilder.html#securityidentity" class="tsd-kind-icon">security<wbr>Identity</a></li>
109
- </ul>
110
- </section>
111
- <section class="tsd-index-section ">
112
- <h3>Methods</h3>
113
- <ul class="tsd-index-list">
114
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="anysecurityidentitybuilder.html#build" class="tsd-kind-icon">build</a></li>
115
- </ul>
116
- </section>
117
- </div>
118
- </section>
119
- </section>
120
- <section class="tsd-panel-group tsd-member-group ">
121
- <h2>Constructors</h2>
122
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
123
- <a name="constructor" class="tsd-anchor"></a>
124
- <h3>constructor</h3>
125
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
126
- <li class="tsd-signature tsd-kind-icon">new <wbr>Any<wbr>Security<wbr>Identity<wbr>Builder<span class="tsd-signature-symbol">(</span>identityType<span class="tsd-signature-symbol">: </span><a href="../modules.html#securityidentitytype" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a>, identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, securityProvider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="anysecurityidentitybuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></li>
127
- </ul>
128
- <ul class="tsd-descriptions">
129
- <li class="tsd-description">
130
- <aside class="tsd-sources">
131
- <ul>
132
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li>
133
- </ul>
134
- </aside>
135
- <h4 class="tsd-parameters-title">Parameters</h4>
136
- <ul class="tsd-parameters">
137
- <li>
138
- <h5>identityType: <a href="../modules.html#securityidentitytype" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a></h5>
139
- </li>
140
- <li>
141
- <h5>identity: <span class="tsd-signature-type">string</span></h5>
142
- </li>
143
- <li>
144
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> securityProvider: <span class="tsd-signature-type">string</span></h5>
145
- <div class="tsd-comment tsd-typography">
146
- </div>
147
- </li>
148
- </ul>
149
- <h4 class="tsd-returns-title">Returns <a href="anysecurityidentitybuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></h4>
150
- </li>
151
- </ul>
152
- </section>
153
- </section>
154
- <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
155
- <h2>Properties</h2>
156
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
157
- <a name="securityidentity" class="tsd-anchor"></a>
158
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> security<wbr>Identity</h3>
159
- <div class="tsd-signature tsd-kind-icon">security<wbr>Identity<span class="tsd-signature-symbol">:</span> <a href="../interfaces/securityidentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></div>
160
- <aside class="tsd-sources">
161
- <ul>
162
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/securityIdentityBuilder.ts#L19">src/securityIdentityBuilder.ts:19</a></li>
163
- </ul>
164
- </aside>
165
- </section>
166
- </section>
167
- <section class="tsd-panel-group tsd-member-group ">
168
- <h2>Methods</h2>
169
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
170
- <a name="build" class="tsd-anchor"></a>
171
- <h3>build</h3>
172
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
173
- <li class="tsd-signature tsd-kind-icon">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/securityidentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></li>
174
- </ul>
175
- <ul class="tsd-descriptions">
176
- <li class="tsd-description">
177
- <aside class="tsd-sources">
178
- <p>Implementation of <a href="../interfaces/securityidentitybuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/securityidentitybuilder.html#build">build</a></p>
179
- <ul>
180
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/securityIdentityBuilder.ts#L42">src/securityIdentityBuilder.ts:42</a></li>
181
- </ul>
182
- </aside>
183
- <div class="tsd-comment tsd-typography">
184
- <div class="lead">
185
- <p>Build and return the security identity.</p>
186
- </div>
187
- </div>
188
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/securityidentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a></h4>
189
- </li>
190
- </ul>
191
- </section>
192
- </section>
193
- </div>
194
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
195
- <nav class="tsd-navigation primary">
196
- <ul>
197
- <li class=" ">
198
- <a href="../modules.html">Exports</a>
199
- </li>
200
- </ul>
201
- </nav>
202
- <nav class="tsd-navigation secondary menu-sticky">
203
- <ul class="before-current">
204
- <li class=" tsd-kind-enum tsd-is-external">
205
- <a href="../enums/environment.html" class="tsd-kind-icon">Environment</a>
206
- </li>
207
- <li class=" tsd-kind-enum tsd-is-external">
208
- <a href="../enums/sourcevisibility.html" class="tsd-kind-icon">Source<wbr>Visibility</a>
209
- </li>
210
- </ul>
211
- <ul class="current">
212
- <li class="current tsd-kind-class">
213
- <a href="anysecurityidentitybuilder.html" class="tsd-kind-icon">Any<wbr>Security<wbr>Identity<wbr>Builder</a>
214
- <ul>
215
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
216
- <a href="anysecurityidentitybuilder.html#constructor" class="tsd-kind-icon">constructor</a>
217
- </li>
218
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
219
- <a href="anysecurityidentitybuilder.html#securityidentity" class="tsd-kind-icon">security<wbr>Identity</a>
220
- </li>
221
- <li class=" tsd-kind-method tsd-parent-kind-class">
222
- <a href="anysecurityidentitybuilder.html#build" class="tsd-kind-icon">build</a>
223
- </li>
224
- </ul>
225
- </li>
226
- </ul>
227
- <ul class="after-current">
228
- <li class=" tsd-kind-class">
229
- <a href="documentbuilder.html" class="tsd-kind-icon">Document<wbr>Builder</a>
230
- </li>
231
- <li class=" tsd-kind-class">
232
- <a href="groupsecurityidentitybuilder.html" class="tsd-kind-icon">Group<wbr>Security<wbr>Identity<wbr>Builder</a>
233
- </li>
234
- <li class=" tsd-kind-class">
235
- <a href="source.html" class="tsd-kind-icon">Source</a>
236
- </li>
237
- <li class=" tsd-kind-class">
238
- <a href="usersecurityidentitybuilder.html" class="tsd-kind-icon">User<wbr>Security<wbr>Identity<wbr>Builder</a>
239
- </li>
240
- <li class=" tsd-kind-class">
241
- <a href="virtualgroupsecurityidentitybuilder.html" class="tsd-kind-icon">Virtual<wbr>Group<wbr>Security<wbr>Identity<wbr>Builder</a>
242
- </li>
243
- <li class=" tsd-kind-interface">
244
- <a href="../interfaces/batchupdatedocuments.html" class="tsd-kind-icon">Batch<wbr>Update<wbr>Documents</a>
245
- </li>
246
- <li class=" tsd-kind-interface">
247
- <a href="../interfaces/document.html" class="tsd-kind-icon">Document</a>
248
- </li>
249
- <li class=" tsd-kind-interface">
250
- <a href="../interfaces/securityidentity.html" class="tsd-kind-icon">Security<wbr>Identity</a>
251
- </li>
252
- <li class=" tsd-kind-interface">
253
- <a href="../interfaces/securityidentitybuilder.html" class="tsd-kind-icon">Security<wbr>Identity<wbr>Builder</a>
254
- </li>
255
- <li class=" tsd-kind-type-alias">
256
- <a href="../modules.html#compressiontype" class="tsd-kind-icon">Compression<wbr>Type</a>
257
- </li>
258
- <li class=" tsd-kind-type-alias">
259
- <a href="../modules.html#metadata" class="tsd-kind-icon">Metadata</a>
260
- </li>
261
- <li class=" tsd-kind-type-alias">
262
- <a href="../modules.html#metadatavalue" class="tsd-kind-icon">Metadata<wbr>Value</a>
263
- </li>
264
- <li class=" tsd-kind-type-alias">
265
- <a href="../modules.html#securityidentitytype" class="tsd-kind-icon">Security<wbr>Identity<wbr>Type</a>
266
- </li>
267
- </ul>
268
- </nav>
269
- </div>
270
- </div>
271
- </div>
272
- <footer class="with-border-bottom">
273
- <div class="container">
274
- <h2>Legend</h2>
275
- <div class="tsd-legend-group">
276
- <ul class="tsd-legend">
277
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
278
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
279
- </ul>
280
- <ul class="tsd-legend">
281
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
282
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
283
- </ul>
284
- <ul class="tsd-legend">
285
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
286
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
287
- </ul>
288
- </div>
289
- </div>
290
- </footer>
291
- <div class="container tsd-generator">
292
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
293
- </div>
294
- <div class="overlay"></div>
295
- <script src="../assets/js/main.js"></script>
296
- </body>
297
- </html>