@fusebase/fusebase-gate-sdk 1.0.2-sdk.4 → 2.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -10
- package/dist/apis/OrgUsersApi.d.ts +12 -1
- package/dist/apis/OrgUsersApi.js +15 -0
- package/dist/apis/SystemApi.d.ts +20 -0
- package/dist/apis/SystemApi.js +29 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +3 -1
- package/dist/types/index.d.ts +2 -20
- package/dist/types/index.js +1 -6
- package/dist/types/org-user/org-user.d.ts +33 -8
- package/dist/types/org-user/org-user.js +0 -4
- package/dist/types/shared/common.d.ts +0 -69
- package/dist/types/shared/common.js +0 -6
- package/dist/types/shared/enums.d.ts +1 -22
- package/dist/types/shared/enums.js +1 -7
- package/dist/types/shared/health.d.ts +0 -6
- package/dist/types/shared/health.js +0 -6
- package/dist/types/shared/parameters.d.ts +0 -54
- package/dist/types/system/system.d.ts +26 -0
- package/dist/types/system/system.js +7 -0
- package/dist/types/token/token.d.ts +0 -127
- package/dist/types/token/token.js +0 -6
- package/package.json +2 -2
- package/dist/apis/CustomDashboardRowsApi.d.ts +0 -113
- package/dist/apis/CustomDashboardRowsApi.js +0 -122
- package/dist/apis/DashboardDataApi.d.ts +0 -98
- package/dist/apis/DashboardDataApi.js +0 -91
- package/dist/apis/DashboardRelationsApi.d.ts +0 -92
- package/dist/apis/DashboardRelationsApi.js +0 -117
- package/dist/apis/DashboardsApi.d.ts +0 -405
- package/dist/apis/DashboardsApi.js +0 -507
- package/dist/apis/DatabasesApi.d.ts +0 -134
- package/dist/apis/DatabasesApi.js +0 -162
- package/dist/apis/ResolveApi.d.ts +0 -20
- package/dist/apis/ResolveApi.js +0 -29
- package/dist/apis/TemplatesApi.d.ts +0 -100
- package/dist/apis/TemplatesApi.js +0 -124
- package/dist/extras/messaging.d.ts +0 -81
- package/dist/extras/messaging.js +0 -16
- package/dist/types/common/portal-form.d.ts +0 -14
- package/dist/types/common/portal-form.js +0 -8
- package/dist/types/dashboard/custom-item.d.ts +0 -53
- package/dist/types/dashboard/custom-item.js +0 -22
- package/dist/types/dashboard/dashboard.d.ts +0 -421
- package/dist/types/dashboard/dashboard.js +0 -8
- package/dist/types/dashboard/dashboards.d.ts +0 -19
- package/dist/types/dashboard/dashboards.js +0 -8
- package/dist/types/dashboard/data.d.ts +0 -10
- package/dist/types/dashboard/data.js +0 -8
- package/dist/types/dashboard/export.d.ts +0 -11
- package/dist/types/dashboard/export.js +0 -8
- package/dist/types/dashboard/index.d.ts +0 -215
- package/dist/types/dashboard/index.js +0 -34
- package/dist/types/dashboard/intent.d.ts +0 -243
- package/dist/types/dashboard/intent.js +0 -8
- package/dist/types/dashboard/items.d.ts +0 -14
- package/dist/types/dashboard/items.js +0 -8
- package/dist/types/dashboard/metadata.d.ts +0 -12
- package/dist/types/dashboard/metadata.js +0 -8
- package/dist/types/dashboard/render.d.ts +0 -188
- package/dist/types/dashboard/render.js +0 -51
- package/dist/types/dashboard/rows.d.ts +0 -77
- package/dist/types/dashboard/rows.js +0 -14
- package/dist/types/dashboard/schema.d.ts +0 -172
- package/dist/types/dashboard/schema.js +0 -17
- package/dist/types/dashboard/values.d.ts +0 -187
- package/dist/types/dashboard/values.js +0 -8
- package/dist/types/dashboard/view.d.ts +0 -249
- package/dist/types/dashboard/view.js +0 -8
- package/dist/types/database/database.d.ts +0 -203
- package/dist/types/database/database.js +0 -8
- package/dist/types/database/export.d.ts +0 -11
- package/dist/types/database/export.js +0 -8
- package/dist/types/relations/relations.d.ts +0 -138
- package/dist/types/relations/relations.js +0 -14
- package/dist/types/resolve/resolve.d.ts +0 -86
- package/dist/types/resolve/resolve.js +0 -20
- package/dist/types/template/template.d.ts +0 -74
- package/dist/types/template/template.js +0 -8
|
@@ -1,507 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* Dashboards API
|
|
4
|
-
*
|
|
5
|
-
* Generated from contract introspection
|
|
6
|
-
* Domain: dashboards
|
|
7
|
-
*/
|
|
8
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.DashboardsApi = void 0;
|
|
10
|
-
class DashboardsApi {
|
|
11
|
-
constructor(client) {
|
|
12
|
-
this.client = client;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* Assign or update representation for a view
|
|
16
|
-
* Create or update a representation instance for a dashboard view. If this is the first representation for the view, it will automatically be set as default.
|
|
17
|
-
*/
|
|
18
|
-
async assignRepresentationToView(params) {
|
|
19
|
-
return this.client.request({
|
|
20
|
-
method: "POST",
|
|
21
|
-
path: "/dashboards/:dashboardId/views/:viewId/representations/:representationTemplateId",
|
|
22
|
-
pathParams: params.path,
|
|
23
|
-
headers: params.headers,
|
|
24
|
-
body: params.body,
|
|
25
|
-
opId: "assignRepresentationToView",
|
|
26
|
-
expectedContentType: "application/json",
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* Copy dashboard from another dashboard
|
|
31
|
-
* Create a new dashboard by copying an existing dashboard with all its views, representations, rows, and optionally data
|
|
32
|
-
*/
|
|
33
|
-
async copyDashboardFromDashboard(params) {
|
|
34
|
-
return this.client.request({
|
|
35
|
-
method: "POST",
|
|
36
|
-
path: "/dashboards/copy-from/dashboard",
|
|
37
|
-
query: params.query,
|
|
38
|
-
headers: params.headers,
|
|
39
|
-
body: params.body,
|
|
40
|
-
opId: "copyDashboardFromDashboard",
|
|
41
|
-
expectedContentType: "application/json",
|
|
42
|
-
});
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* Create dashboard
|
|
46
|
-
* Create a new dashboard
|
|
47
|
-
*/
|
|
48
|
-
async createDashboard(params) {
|
|
49
|
-
return this.client.request({
|
|
50
|
-
method: "POST",
|
|
51
|
-
path: "/dashboards",
|
|
52
|
-
headers: params.headers,
|
|
53
|
-
body: params.body,
|
|
54
|
-
opId: "createDashboard",
|
|
55
|
-
expectedContentType: "application/json",
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
|
-
/**
|
|
59
|
-
* Create dashboard from form
|
|
60
|
-
* Create a new dashboard based on an existing form
|
|
61
|
-
*/
|
|
62
|
-
async createDashboardFromForm(params) {
|
|
63
|
-
return this.client.request({
|
|
64
|
-
method: "POST",
|
|
65
|
-
path: "/dashboards/copy-from/form",
|
|
66
|
-
headers: params.headers,
|
|
67
|
-
body: params.body,
|
|
68
|
-
opId: "createDashboardFromForm",
|
|
69
|
-
expectedContentType: "application/json",
|
|
70
|
-
});
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* Create dashboard from template
|
|
74
|
-
* Create a new dashboard based on an existing template
|
|
75
|
-
*/
|
|
76
|
-
async createDashboardFromTemplate(params) {
|
|
77
|
-
return this.client.request({
|
|
78
|
-
method: "POST",
|
|
79
|
-
path: "/dashboards/copy-from/template",
|
|
80
|
-
headers: params.headers,
|
|
81
|
-
body: params.body,
|
|
82
|
-
opId: "createDashboardFromTemplate",
|
|
83
|
-
expectedContentType: "application/json",
|
|
84
|
-
});
|
|
85
|
-
}
|
|
86
|
-
/**
|
|
87
|
-
* Create dashboard via Intent
|
|
88
|
-
* Create a new dashboard using a simplified Intent payload.
|
|
89
|
-
* The Intent payload is enriched into a canonical full schema using allowed-items templates.
|
|
90
|
-
* Keys and aliases are auto-generated if not provided.
|
|
91
|
-
*
|
|
92
|
-
*/
|
|
93
|
-
async createDashboardIntent(params) {
|
|
94
|
-
return this.client.request({
|
|
95
|
-
method: "POST",
|
|
96
|
-
path: "/dashboards/intent",
|
|
97
|
-
headers: params.headers,
|
|
98
|
-
body: params.body,
|
|
99
|
-
opId: "createDashboardIntent",
|
|
100
|
-
expectedContentType: "application/json",
|
|
101
|
-
});
|
|
102
|
-
}
|
|
103
|
-
/**
|
|
104
|
-
* Create dashboard view
|
|
105
|
-
* Create a new dashboard view
|
|
106
|
-
*/
|
|
107
|
-
async createDashboardView(params) {
|
|
108
|
-
return this.client.request({
|
|
109
|
-
method: "POST",
|
|
110
|
-
path: "/dashboards/:dashboardId/views",
|
|
111
|
-
pathParams: params.path,
|
|
112
|
-
headers: params.headers,
|
|
113
|
-
body: params.body,
|
|
114
|
-
opId: "createDashboardView",
|
|
115
|
-
expectedContentType: "application/json",
|
|
116
|
-
});
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* Create a dashboard view representation template (system endpoint)
|
|
120
|
-
* Create a new dashboard view representation template with its scope.
|
|
121
|
-
* This is a system endpoint used for internal operations.
|
|
122
|
-
*
|
|
123
|
-
*/
|
|
124
|
-
async createDashboardViewRepresentationTemplate(params) {
|
|
125
|
-
return this.client.request({
|
|
126
|
-
method: "POST",
|
|
127
|
-
path: "/_system/representation-templates",
|
|
128
|
-
headers: params.headers,
|
|
129
|
-
body: params.body,
|
|
130
|
-
opId: "createDashboardViewRepresentationTemplate",
|
|
131
|
-
expectedContentType: "application/json",
|
|
132
|
-
});
|
|
133
|
-
}
|
|
134
|
-
/**
|
|
135
|
-
* Create dashboard view via Intent
|
|
136
|
-
* Create a new dashboard view using a simplified Intent payload.
|
|
137
|
-
* Specify which columns from the dashboard schema to include in the view.
|
|
138
|
-
* Schema items must already exist in the dashboard before they can be included in a view.
|
|
139
|
-
* Does NOT modify the dashboard schema.
|
|
140
|
-
*
|
|
141
|
-
*/
|
|
142
|
-
async createViewIntent(params) {
|
|
143
|
-
return this.client.request({
|
|
144
|
-
method: "POST",
|
|
145
|
-
path: "/dashboards/:dashboardId/views/intent",
|
|
146
|
-
pathParams: params.path,
|
|
147
|
-
headers: params.headers,
|
|
148
|
-
body: params.body,
|
|
149
|
-
opId: "createViewIntent",
|
|
150
|
-
expectedContentType: "application/json",
|
|
151
|
-
});
|
|
152
|
-
}
|
|
153
|
-
/**
|
|
154
|
-
* Delete dashboard by UUID
|
|
155
|
-
* Delete a dashboard (soft delete) by UUID
|
|
156
|
-
*/
|
|
157
|
-
async deleteDashboard(params) {
|
|
158
|
-
return this.client.request({
|
|
159
|
-
method: "DELETE",
|
|
160
|
-
path: "/dashboards/:dashboardId",
|
|
161
|
-
pathParams: params.path,
|
|
162
|
-
headers: params.headers,
|
|
163
|
-
opId: "deleteDashboard",
|
|
164
|
-
expectedContentType: "application/json",
|
|
165
|
-
});
|
|
166
|
-
}
|
|
167
|
-
/**
|
|
168
|
-
* Permanently delete dashboard schema item
|
|
169
|
-
* Permanently delete a schema item from a dashboard and all views by its key by dashboard UUID
|
|
170
|
-
*/
|
|
171
|
-
async deleteDashboardSchemaItem(params) {
|
|
172
|
-
return this.client.request({
|
|
173
|
-
method: "DELETE",
|
|
174
|
-
path: "/dashboards/:dashboardId/schema/items/:itemKey",
|
|
175
|
-
pathParams: params.path,
|
|
176
|
-
headers: params.headers,
|
|
177
|
-
opId: "deleteDashboardSchemaItem",
|
|
178
|
-
expectedContentType: "application/json",
|
|
179
|
-
});
|
|
180
|
-
}
|
|
181
|
-
/**
|
|
182
|
-
* Delete dashboard view
|
|
183
|
-
* Delete a dashboard view (soft delete)
|
|
184
|
-
*/
|
|
185
|
-
async deleteDashboardView(params) {
|
|
186
|
-
return this.client.request({
|
|
187
|
-
method: "DELETE",
|
|
188
|
-
path: "/dashboards/:dashboardId/views/:viewId",
|
|
189
|
-
pathParams: params.path,
|
|
190
|
-
headers: params.headers,
|
|
191
|
-
opId: "deleteDashboardView",
|
|
192
|
-
expectedContentType: "application/json",
|
|
193
|
-
});
|
|
194
|
-
}
|
|
195
|
-
/**
|
|
196
|
-
* Describe dashboard by UUID
|
|
197
|
-
* Describe a specific dashboard by UUID
|
|
198
|
-
*/
|
|
199
|
-
async describeDashboard(params) {
|
|
200
|
-
return this.client.request({
|
|
201
|
-
method: "GET",
|
|
202
|
-
path: "/dashboards/:dashboardId/describe",
|
|
203
|
-
pathParams: params.path,
|
|
204
|
-
headers: params.headers,
|
|
205
|
-
opId: "describeDashboard",
|
|
206
|
-
expectedContentType: "application/json",
|
|
207
|
-
});
|
|
208
|
-
}
|
|
209
|
-
/**
|
|
210
|
-
* Export dashboard data as CSV
|
|
211
|
-
* Export dashboard data as CSV format
|
|
212
|
-
*/
|
|
213
|
-
async exportDashboardAsCsv(params) {
|
|
214
|
-
return this.client.request({
|
|
215
|
-
method: "GET",
|
|
216
|
-
path: "/dashboards/:dashboardId/export/csv",
|
|
217
|
-
pathParams: params.path,
|
|
218
|
-
query: params.query,
|
|
219
|
-
headers: params.headers,
|
|
220
|
-
opId: "exportDashboardAsCsv",
|
|
221
|
-
expectedContentType: "text/csv",
|
|
222
|
-
});
|
|
223
|
-
}
|
|
224
|
-
/**
|
|
225
|
-
* Export dashboard as JSON
|
|
226
|
-
* Export dashboard structure and optionally data as JSON
|
|
227
|
-
*/
|
|
228
|
-
async exportDashboardAsJson(params) {
|
|
229
|
-
return this.client.request({
|
|
230
|
-
method: "GET",
|
|
231
|
-
path: "/dashboards/:dashboardId/views/:viewId/export/json",
|
|
232
|
-
pathParams: params.path,
|
|
233
|
-
query: params.query,
|
|
234
|
-
headers: params.headers,
|
|
235
|
-
opId: "exportDashboardAsJson",
|
|
236
|
-
expectedContentType: "application/json",
|
|
237
|
-
});
|
|
238
|
-
}
|
|
239
|
-
/**
|
|
240
|
-
* Get or create child table link dashboard
|
|
241
|
-
* Get or create dashboard for a child-table-link cell.
|
|
242
|
-
* If childTableId in cell is null, creates new dashboard using template from schema item.
|
|
243
|
-
* If childTableId exists, returns the existing dashboard.
|
|
244
|
-
* Automatically updates the cell with the created dashboard ID.
|
|
245
|
-
*
|
|
246
|
-
*/
|
|
247
|
-
async getChildTableLinkDashboard(params) {
|
|
248
|
-
return this.client.request({
|
|
249
|
-
method: "POST",
|
|
250
|
-
path: "/dashboards/get-child-table-link-dashboard",
|
|
251
|
-
headers: params.headers,
|
|
252
|
-
body: params.body,
|
|
253
|
-
opId: "getChildTableLinkDashboard",
|
|
254
|
-
expectedContentType: "application/json",
|
|
255
|
-
});
|
|
256
|
-
}
|
|
257
|
-
/**
|
|
258
|
-
* Get dashboard
|
|
259
|
-
* Get a specific dashboard by UUID
|
|
260
|
-
*/
|
|
261
|
-
async getDashboard(params) {
|
|
262
|
-
return this.client.request({
|
|
263
|
-
method: "GET",
|
|
264
|
-
path: "/dashboards/:dashboardId",
|
|
265
|
-
pathParams: params.path,
|
|
266
|
-
headers: params.headers,
|
|
267
|
-
opId: "getDashboard",
|
|
268
|
-
expectedContentType: "application/json",
|
|
269
|
-
});
|
|
270
|
-
}
|
|
271
|
-
/**
|
|
272
|
-
* Get available fields and related dashboards
|
|
273
|
-
* Returns the list of allowed SchemaItem fields for the specified dashboard, along with names and IDs of related dashboards.
|
|
274
|
-
*/
|
|
275
|
-
async getDashboardAllowedItems(params) {
|
|
276
|
-
return this.client.request({
|
|
277
|
-
method: "GET",
|
|
278
|
-
path: "/dashboards/:dashboardId/allowed-items",
|
|
279
|
-
pathParams: params.path,
|
|
280
|
-
query: params.query,
|
|
281
|
-
headers: params.headers,
|
|
282
|
-
opId: "getDashboardAllowedItems",
|
|
283
|
-
expectedContentType: "application/json",
|
|
284
|
-
});
|
|
285
|
-
}
|
|
286
|
-
/**
|
|
287
|
-
* Get allowed fields by root entity without related dashboards
|
|
288
|
-
* Returns the list of allowed SchemaItem fields without related dashboards. Returns only common fields that are allowed to be used in the dashboard specified by the root entity.
|
|
289
|
-
*/
|
|
290
|
-
async getDashboardAllowedItemsByRootEntity(params) {
|
|
291
|
-
return this.client.request({
|
|
292
|
-
method: "GET",
|
|
293
|
-
path: "/dashboards/allowed-items",
|
|
294
|
-
query: params.query,
|
|
295
|
-
headers: params.headers,
|
|
296
|
-
opId: "getDashboardAllowedItemsByRootEntity",
|
|
297
|
-
expectedContentType: "application/json",
|
|
298
|
-
});
|
|
299
|
-
}
|
|
300
|
-
/**
|
|
301
|
-
* Get fields types supported for CSV columns mapping
|
|
302
|
-
* Returns a list of SchemaItem fields that are supported for mapping to CSV columns
|
|
303
|
-
*/
|
|
304
|
-
async getDashboardCsvImportAllowedItems(params) {
|
|
305
|
-
return this.client.request({
|
|
306
|
-
method: "GET",
|
|
307
|
-
path: "/dashboards/import/csv/allowed-items",
|
|
308
|
-
query: params.query,
|
|
309
|
-
headers: params.headers,
|
|
310
|
-
opId: "getDashboardCsvImportAllowedItems",
|
|
311
|
-
expectedContentType: "application/json",
|
|
312
|
-
});
|
|
313
|
-
}
|
|
314
|
-
/**
|
|
315
|
-
* List dashboards
|
|
316
|
-
* Get a list of dashboards with optional filtering
|
|
317
|
-
*/
|
|
318
|
-
async getDashboards(params) {
|
|
319
|
-
return this.client.request({
|
|
320
|
-
method: "GET",
|
|
321
|
-
path: "/dashboards",
|
|
322
|
-
query: params.query,
|
|
323
|
-
headers: params.headers,
|
|
324
|
-
opId: "getDashboards",
|
|
325
|
-
expectedContentType: "application/json",
|
|
326
|
-
});
|
|
327
|
-
}
|
|
328
|
-
/**
|
|
329
|
-
* Get dashboard view
|
|
330
|
-
* Get a specific dashboard view by ID
|
|
331
|
-
*/
|
|
332
|
-
async getDashboardView(params) {
|
|
333
|
-
return this.client.request({
|
|
334
|
-
method: "GET",
|
|
335
|
-
path: "/dashboards/:dashboardId/views/:viewId",
|
|
336
|
-
pathParams: params.path,
|
|
337
|
-
query: params.query,
|
|
338
|
-
headers: params.headers,
|
|
339
|
-
opId: "getDashboardView",
|
|
340
|
-
expectedContentType: "application/json",
|
|
341
|
-
});
|
|
342
|
-
}
|
|
343
|
-
/**
|
|
344
|
-
* Get dashboard view templates for an organization
|
|
345
|
-
* Fetch dashboard view templates for a specific organization.
|
|
346
|
-
* Returns all managed templates and custom templates that have the provided scope ID in their scopes.
|
|
347
|
-
*
|
|
348
|
-
*/
|
|
349
|
-
async getDashboardViewRepresentationTemplates(params) {
|
|
350
|
-
return this.client.request({
|
|
351
|
-
method: "GET",
|
|
352
|
-
path: "/representation-templates",
|
|
353
|
-
query: params.query,
|
|
354
|
-
headers: params.headers,
|
|
355
|
-
opId: "getDashboardViewRepresentationTemplates",
|
|
356
|
-
expectedContentType: "application/json",
|
|
357
|
-
});
|
|
358
|
-
}
|
|
359
|
-
/**
|
|
360
|
-
* Get or create dashboard
|
|
361
|
-
* Find dashboard by alias and scope, or create new one if not found.
|
|
362
|
-
* If creating from template, searches for template in template_scope first,
|
|
363
|
-
* then org scope from scopes array, then system org (from SYSTEM_ORG_SCOPE_ID env var).
|
|
364
|
-
*
|
|
365
|
-
*/
|
|
366
|
-
async getOrCreateDashboard(params) {
|
|
367
|
-
return this.client.request({
|
|
368
|
-
method: "POST",
|
|
369
|
-
path: "/dashboards/get-or-create",
|
|
370
|
-
query: params.query,
|
|
371
|
-
headers: params.headers,
|
|
372
|
-
body: params.body,
|
|
373
|
-
opId: "getOrCreateDashboard",
|
|
374
|
-
expectedContentType: "application/json",
|
|
375
|
-
});
|
|
376
|
-
}
|
|
377
|
-
/**
|
|
378
|
-
* Get a list of forms
|
|
379
|
-
* Get a list of forms for a given org
|
|
380
|
-
*/
|
|
381
|
-
async getPortalFormsList(params) {
|
|
382
|
-
return this.client.request({
|
|
383
|
-
method: "GET",
|
|
384
|
-
path: "/dashboards/copy-from/form/list",
|
|
385
|
-
query: params.query,
|
|
386
|
-
headers: params.headers,
|
|
387
|
-
opId: "getPortalFormsList",
|
|
388
|
-
expectedContentType: "application/json",
|
|
389
|
-
});
|
|
390
|
-
}
|
|
391
|
-
/**
|
|
392
|
-
* Import dashboard from JSON
|
|
393
|
-
* Import a dashboard from exported JSON structure
|
|
394
|
-
*/
|
|
395
|
-
async importDashboard(params) {
|
|
396
|
-
return this.client.request({
|
|
397
|
-
method: "POST",
|
|
398
|
-
path: "/dashboards/import",
|
|
399
|
-
headers: params.headers,
|
|
400
|
-
body: params.body,
|
|
401
|
-
opId: "importDashboard",
|
|
402
|
-
expectedContentType: "application/json",
|
|
403
|
-
});
|
|
404
|
-
}
|
|
405
|
-
/**
|
|
406
|
-
* Import dashboard data from CSV
|
|
407
|
-
* The mapping parameter uses OpenAPI's deepObject style with bracket notation
|
|
408
|
-
* for type-safe serialization in the generated client.
|
|
409
|
-
* Example query string:
|
|
410
|
-
* ?database_id=8b7c5d9d-f178-4b2a-99fb-bc3d5c363a6f&mapping[columns][0][index]=0&mapping[columns][0][type]=string&mapping[columns][0][edit_type]=string-single-line&mapping[columns][1][index]=1&mapping[columns][1][type]=number&mapping[columns][1][edit_type]=number
|
|
411
|
-
*
|
|
412
|
-
*/
|
|
413
|
-
async importDashboardFromCsv(params) {
|
|
414
|
-
return this.client.request({
|
|
415
|
-
method: "POST",
|
|
416
|
-
path: "/dashboards/import/csv",
|
|
417
|
-
query: params.query,
|
|
418
|
-
headers: params.headers,
|
|
419
|
-
body: params.body,
|
|
420
|
-
opId: "importDashboardFromCsv",
|
|
421
|
-
expectedContentType: "application/json",
|
|
422
|
-
});
|
|
423
|
-
}
|
|
424
|
-
/**
|
|
425
|
-
* Update dashboard
|
|
426
|
-
* Update an existing dashboard by UUID
|
|
427
|
-
*/
|
|
428
|
-
async updateDashboard(params) {
|
|
429
|
-
return this.client.request({
|
|
430
|
-
method: "PUT",
|
|
431
|
-
path: "/dashboards/:dashboardId",
|
|
432
|
-
pathParams: params.path,
|
|
433
|
-
headers: params.headers,
|
|
434
|
-
body: params.body,
|
|
435
|
-
opId: "updateDashboard",
|
|
436
|
-
expectedContentType: "application/json",
|
|
437
|
-
});
|
|
438
|
-
}
|
|
439
|
-
/**
|
|
440
|
-
* Update dashboard schema via Intent patch
|
|
441
|
-
* Update dashboard schema items using a simplified Intent patch payload.
|
|
442
|
-
* Supports add, update, and remove operations on schema items.
|
|
443
|
-
* Only specified items are modified; others remain unchanged.
|
|
444
|
-
* The Intent payload is enriched into canonical full schema items using allowed-items templates.
|
|
445
|
-
*
|
|
446
|
-
*/
|
|
447
|
-
async updateDashboardSchemaIntent(params) {
|
|
448
|
-
return this.client.request({
|
|
449
|
-
method: "PATCH",
|
|
450
|
-
path: "/dashboards/:dashboardId/schema/intent",
|
|
451
|
-
pathParams: params.path,
|
|
452
|
-
headers: params.headers,
|
|
453
|
-
body: params.body,
|
|
454
|
-
opId: "updateDashboardSchemaIntent",
|
|
455
|
-
expectedContentType: "application/json",
|
|
456
|
-
});
|
|
457
|
-
}
|
|
458
|
-
/**
|
|
459
|
-
* Update dashboard view
|
|
460
|
-
* Update an existing dashboard view
|
|
461
|
-
*/
|
|
462
|
-
async updateDashboardView(params) {
|
|
463
|
-
return this.client.request({
|
|
464
|
-
method: "PUT",
|
|
465
|
-
path: "/dashboards/:dashboardId/views/:viewId",
|
|
466
|
-
pathParams: params.path,
|
|
467
|
-
headers: params.headers,
|
|
468
|
-
body: params.body,
|
|
469
|
-
opId: "updateDashboardView",
|
|
470
|
-
expectedContentType: "application/json",
|
|
471
|
-
});
|
|
472
|
-
}
|
|
473
|
-
/**
|
|
474
|
-
* Update dashboard view filters
|
|
475
|
-
* Update only the filters configuration of a dashboard view
|
|
476
|
-
*/
|
|
477
|
-
async updateDashboardViewFilters(params) {
|
|
478
|
-
return this.client.request({
|
|
479
|
-
method: "PUT",
|
|
480
|
-
path: "/dashboards/:dashboardId/views/:viewId/filters",
|
|
481
|
-
pathParams: params.path,
|
|
482
|
-
headers: params.headers,
|
|
483
|
-
body: params.body,
|
|
484
|
-
opId: "updateDashboardViewFilters",
|
|
485
|
-
expectedContentType: "application/json",
|
|
486
|
-
});
|
|
487
|
-
}
|
|
488
|
-
/**
|
|
489
|
-
* Update view schema via Intent patch
|
|
490
|
-
* Update view schema using the same Intent patch payload as dashboard schema updates.
|
|
491
|
-
* Supports add, update, and remove operations on schema items for this view.
|
|
492
|
-
* Uses UpdateSchemaIntentRequest (schema_patch) — same payload as PATCH /dashboards/{id}/schema/intent.
|
|
493
|
-
*
|
|
494
|
-
*/
|
|
495
|
-
async updateViewIntent(params) {
|
|
496
|
-
return this.client.request({
|
|
497
|
-
method: "PUT",
|
|
498
|
-
path: "/dashboards/:dashboardId/views/:viewId/intent",
|
|
499
|
-
pathParams: params.path,
|
|
500
|
-
headers: params.headers,
|
|
501
|
-
body: params.body,
|
|
502
|
-
opId: "updateViewIntent",
|
|
503
|
-
expectedContentType: "application/json",
|
|
504
|
-
});
|
|
505
|
-
}
|
|
506
|
-
}
|
|
507
|
-
exports.DashboardsApi = DashboardsApi;
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Databases API
|
|
3
|
-
*
|
|
4
|
-
* Generated from contract introspection
|
|
5
|
-
* Domain: databases
|
|
6
|
-
*/
|
|
7
|
-
import type { Client } from "../runtime/transport";
|
|
8
|
-
import type { aliasInQueryOptional, aliasInQueryRequired, CopyDatabaseFromDatabaseRequestContract, copyDataInQueryRequired, copyRelationsInQueryRequired, copyTablesInQueryRequired, copyViewsInQueryRequired, CreateDatabaseRequestContract, createDefaultRowsInQuery, DatabaseListResponseContract, DatabaseResponseContract, ExportDatabaseAsJson200ResponseContract, GetOrCreateDatabaseRequestContract, GetOrCreateDatabaseResponseContract, ImportDatabaseRequestContract, limitInQueryOptional, pageInQueryOptional, scopeIdInQueryRequired, scopeTypeOrgInQueryRequired, UpdateDatabaseRequestContract } from "../types";
|
|
9
|
-
export declare class DatabasesApi {
|
|
10
|
-
private client;
|
|
11
|
-
constructor(client: Client);
|
|
12
|
-
/**
|
|
13
|
-
* Copy database from another database
|
|
14
|
-
* Create a new database by copying an existing database with all its dashboards, relations, and optionally data
|
|
15
|
-
*/
|
|
16
|
-
copyDatabaseFromDatabase(params: {
|
|
17
|
-
query?: {
|
|
18
|
-
copy_tables: copyTablesInQueryRequired;
|
|
19
|
-
copy_views: copyViewsInQueryRequired;
|
|
20
|
-
copy_data: copyDataInQueryRequired;
|
|
21
|
-
copy_relations: copyRelationsInQueryRequired;
|
|
22
|
-
create_default_rows?: createDefaultRowsInQuery;
|
|
23
|
-
};
|
|
24
|
-
headers?: Record<string, string>;
|
|
25
|
-
body: CopyDatabaseFromDatabaseRequestContract;
|
|
26
|
-
}): Promise<DatabaseResponseContract>;
|
|
27
|
-
/**
|
|
28
|
-
* Create a new database
|
|
29
|
-
* Create a new database with the provided information
|
|
30
|
-
*/
|
|
31
|
-
createDatabase(params: {
|
|
32
|
-
query?: {
|
|
33
|
-
no_default_dashboard?: boolean;
|
|
34
|
-
};
|
|
35
|
-
headers?: Record<string, string>;
|
|
36
|
-
body: CreateDatabaseRequestContract;
|
|
37
|
-
}): Promise<DatabaseResponseContract>;
|
|
38
|
-
/**
|
|
39
|
-
* Delete database
|
|
40
|
-
* Soft delete a database
|
|
41
|
-
*/
|
|
42
|
-
deleteDatabase(params: {
|
|
43
|
-
path: {
|
|
44
|
-
id: string;
|
|
45
|
-
};
|
|
46
|
-
headers?: Record<string, string>;
|
|
47
|
-
}): Promise<void>;
|
|
48
|
-
/**
|
|
49
|
-
* Export database data as CSV
|
|
50
|
-
* Export database data as CSV format
|
|
51
|
-
*/
|
|
52
|
-
exportDatabaseAsCsv(params: {
|
|
53
|
-
path: {
|
|
54
|
-
id: string;
|
|
55
|
-
};
|
|
56
|
-
headers?: Record<string, string>;
|
|
57
|
-
}): Promise<string>;
|
|
58
|
-
/**
|
|
59
|
-
* Export database as JSON
|
|
60
|
-
* Export database structure and optionally data as JSON
|
|
61
|
-
*/
|
|
62
|
-
exportDatabaseAsJson(params: {
|
|
63
|
-
path: {
|
|
64
|
-
id: string;
|
|
65
|
-
};
|
|
66
|
-
query?: {
|
|
67
|
-
structure?: boolean;
|
|
68
|
-
data?: boolean;
|
|
69
|
-
};
|
|
70
|
-
headers?: Record<string, string>;
|
|
71
|
-
}): Promise<ExportDatabaseAsJson200ResponseContract>;
|
|
72
|
-
/**
|
|
73
|
-
* Get all databases
|
|
74
|
-
* Retrieve a list of all databases
|
|
75
|
-
*/
|
|
76
|
-
getAllDatabases(params: {
|
|
77
|
-
query?: {
|
|
78
|
-
include_expanded?: boolean;
|
|
79
|
-
sort_by?: string;
|
|
80
|
-
sort_order?: string;
|
|
81
|
-
alias?: aliasInQueryOptional;
|
|
82
|
-
scope_type: scopeTypeOrgInQueryRequired;
|
|
83
|
-
scope_id: scopeIdInQueryRequired;
|
|
84
|
-
page?: pageInQueryOptional;
|
|
85
|
-
limit?: limitInQueryOptional;
|
|
86
|
-
};
|
|
87
|
-
headers?: Record<string, string>;
|
|
88
|
-
}): Promise<DatabaseListResponseContract>;
|
|
89
|
-
/**
|
|
90
|
-
* Get database by ID
|
|
91
|
-
* Retrieve a specific database by its global ID
|
|
92
|
-
*/
|
|
93
|
-
getDatabaseById(params: {
|
|
94
|
-
path: {
|
|
95
|
-
id: string;
|
|
96
|
-
};
|
|
97
|
-
headers?: Record<string, string>;
|
|
98
|
-
}): Promise<DatabaseResponseContract>;
|
|
99
|
-
/**
|
|
100
|
-
* Get or create database
|
|
101
|
-
* Find database by alias and scope, or create new one if not found.
|
|
102
|
-
* If creating from template, searches for template in template_scope first,
|
|
103
|
-
* then org scope from scopes array, then system org (from SYSTEM_ORG_SCOPE_ID env var).
|
|
104
|
-
*
|
|
105
|
-
*/
|
|
106
|
-
getOrCreateDatabase(params: {
|
|
107
|
-
query?: {
|
|
108
|
-
alias: aliasInQueryRequired;
|
|
109
|
-
scope_type: scopeTypeOrgInQueryRequired;
|
|
110
|
-
scope_id: scopeIdInQueryRequired;
|
|
111
|
-
};
|
|
112
|
-
headers?: Record<string, string>;
|
|
113
|
-
body: GetOrCreateDatabaseRequestContract;
|
|
114
|
-
}): Promise<GetOrCreateDatabaseResponseContract>;
|
|
115
|
-
/**
|
|
116
|
-
* Import database from JSON
|
|
117
|
-
* Import a database from exported JSON structure
|
|
118
|
-
*/
|
|
119
|
-
importDatabase(params: {
|
|
120
|
-
headers?: Record<string, string>;
|
|
121
|
-
body: ImportDatabaseRequestContract;
|
|
122
|
-
}): Promise<DatabaseResponseContract>;
|
|
123
|
-
/**
|
|
124
|
-
* Update database
|
|
125
|
-
* Update an existing database
|
|
126
|
-
*/
|
|
127
|
-
updateDatabase(params: {
|
|
128
|
-
path: {
|
|
129
|
-
id: string;
|
|
130
|
-
};
|
|
131
|
-
headers?: Record<string, string>;
|
|
132
|
-
body: UpdateDatabaseRequestContract;
|
|
133
|
-
}): Promise<DatabaseResponseContract>;
|
|
134
|
-
}
|