@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/interfaces/batchupdatedocuments.html DELETED
@@ -1,214 +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>BatchUpdateDocuments | @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="batchupdatedocuments.html">BatchUpdateDocuments</a>
59
- </li>
60
- </ul>
61
- <h1>Interface BatchUpdateDocuments</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-hierarchy">
69
- <h3>Hierarchy</h3>
70
- <ul class="tsd-hierarchy">
71
- <li>
72
- <span class="target">BatchUpdateDocuments</span>
73
- </li>
74
- </ul>
75
- </section>
76
- <section class="tsd-panel-group tsd-index-group">
77
- <h2>Index</h2>
78
- <section class="tsd-panel tsd-index-panel">
79
- <div class="tsd-index-content">
80
- <section class="tsd-index-section ">
81
- <h3>Properties</h3>
82
- <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="batchupdatedocuments.html#addorupdate" class="tsd-kind-icon">add<wbr>OrUpdate</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="batchupdatedocuments.html#delete" class="tsd-kind-icon">delete</a></li>
85
- </ul>
86
- </section>
87
- </div>
88
- </section>
89
- </section>
90
- <section class="tsd-panel-group tsd-member-group ">
91
- <h2>Properties</h2>
92
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
- <a name="addorupdate" class="tsd-anchor"></a>
94
- <h3>add<wbr>OrUpdate</h3>
95
- <div class="tsd-signature tsd-kind-icon">add<wbr>OrUpdate<span class="tsd-signature-symbol">:</span> <a href="../classes/documentbuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div>
96
- <aside class="tsd-sources">
97
- <ul>
98
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/source.ts#L24">src/source.ts:24</a></li>
99
- </ul>
100
- </aside>
101
- </section>
102
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
103
- <a name="delete" class="tsd-anchor"></a>
104
- <h3>delete</h3>
105
- <div class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div>
106
- <aside class="tsd-sources">
107
- <ul>
108
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/source.ts#L25">src/source.ts:25</a></li>
109
- </ul>
110
- </aside>
111
- </section>
112
- </section>
113
- </div>
114
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
115
- <nav class="tsd-navigation primary">
116
- <ul>
117
- <li class=" ">
118
- <a href="../modules.html">Exports</a>
119
- </li>
120
- </ul>
121
- </nav>
122
- <nav class="tsd-navigation secondary menu-sticky">
123
- <ul class="before-current">
124
- <li class=" tsd-kind-enum tsd-is-external">
125
- <a href="../enums/environment.html" class="tsd-kind-icon">Environment</a>
126
- </li>
127
- <li class=" tsd-kind-enum tsd-is-external">
128
- <a href="../enums/sourcevisibility.html" class="tsd-kind-icon">Source<wbr>Visibility</a>
129
- </li>
130
- <li class=" tsd-kind-class">
131
- <a href="../classes/anysecurityidentitybuilder.html" class="tsd-kind-icon">Any<wbr>Security<wbr>Identity<wbr>Builder</a>
132
- </li>
133
- <li class=" tsd-kind-class">
134
- <a href="../classes/documentbuilder.html" class="tsd-kind-icon">Document<wbr>Builder</a>
135
- </li>
136
- <li class=" tsd-kind-class">
137
- <a href="../classes/groupsecurityidentitybuilder.html" class="tsd-kind-icon">Group<wbr>Security<wbr>Identity<wbr>Builder</a>
138
- </li>
139
- <li class=" tsd-kind-class">
140
- <a href="../classes/source.html" class="tsd-kind-icon">Source</a>
141
- </li>
142
- <li class=" tsd-kind-class">
143
- <a href="../classes/usersecurityidentitybuilder.html" class="tsd-kind-icon">User<wbr>Security<wbr>Identity<wbr>Builder</a>
144
- </li>
145
- <li class=" tsd-kind-class">
146
- <a href="../classes/virtualgroupsecurityidentitybuilder.html" class="tsd-kind-icon">Virtual<wbr>Group<wbr>Security<wbr>Identity<wbr>Builder</a>
147
- </li>
148
- </ul>
149
- <ul class="current">
150
- <li class="current tsd-kind-interface">
151
- <a href="batchupdatedocuments.html" class="tsd-kind-icon">Batch<wbr>Update<wbr>Documents</a>
152
- <ul>
153
- <li class=" tsd-kind-property tsd-parent-kind-interface">
154
- <a href="batchupdatedocuments.html#addorupdate" class="tsd-kind-icon">add<wbr>OrUpdate</a>
155
- </li>
156
- <li class=" tsd-kind-property tsd-parent-kind-interface">
157
- <a href="batchupdatedocuments.html#delete" class="tsd-kind-icon">delete</a>
158
- </li>
159
- </ul>
160
- </li>
161
- </ul>
162
- <ul class="after-current">
163
- <li class=" tsd-kind-interface">
164
- <a href="document.html" class="tsd-kind-icon">Document</a>
165
- </li>
166
- <li class=" tsd-kind-interface">
167
- <a href="securityidentity.html" class="tsd-kind-icon">Security<wbr>Identity</a>
168
- </li>
169
- <li class=" tsd-kind-interface">
170
- <a href="securityidentitybuilder.html" class="tsd-kind-icon">Security<wbr>Identity<wbr>Builder</a>
171
- </li>
172
- <li class=" tsd-kind-type-alias">
173
- <a href="../modules.html#compressiontype" class="tsd-kind-icon">Compression<wbr>Type</a>
174
- </li>
175
- <li class=" tsd-kind-type-alias">
176
- <a href="../modules.html#metadata" class="tsd-kind-icon">Metadata</a>
177
- </li>
178
- <li class=" tsd-kind-type-alias">
179
- <a href="../modules.html#metadatavalue" class="tsd-kind-icon">Metadata<wbr>Value</a>
180
- </li>
181
- <li class=" tsd-kind-type-alias">
182
- <a href="../modules.html#securityidentitytype" class="tsd-kind-icon">Security<wbr>Identity<wbr>Type</a>
183
- </li>
184
- </ul>
185
- </nav>
186
- </div>
187
- </div>
188
- </div>
189
- <footer class="with-border-bottom">
190
- <div class="container">
191
- <h2>Legend</h2>
192
- <div class="tsd-legend-group">
193
- <ul class="tsd-legend">
194
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
195
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
196
- </ul>
197
- <ul class="tsd-legend">
198
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
199
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
200
- </ul>
201
- <ul class="tsd-legend">
202
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
203
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
204
- </ul>
205
- </div>
206
- </div>
207
- </footer>
208
- <div class="container tsd-generator">
209
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
210
- </div>
211
- <div class="overlay"></div>
212
- <script src="../assets/js/main.js"></script>
213
- </body>
214
- </html>