@fusebase/fusebase-gate-sdk 1.0.2-sdk.4 → 2.0.8
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,249 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* View Schemas
|
|
3
|
-
*
|
|
4
|
-
* Generated from OpenAPI specification
|
|
5
|
-
* Source: schemas/dashboard/view.yaml
|
|
6
|
-
*/
|
|
7
|
-
import type { AliasContract, FilterConfigContract, StandardApiResponseContract } from "../shared/common";
|
|
8
|
-
import type { DashboardRefContract } from "./dashboard";
|
|
9
|
-
import type { DashboardMetadataContract } from "./metadata";
|
|
10
|
-
import type { DashboardSchemaContract } from "./schema";
|
|
11
|
-
export interface AssignRepresentationToViewRequestContract {
|
|
12
|
-
/**
|
|
13
|
-
* Whether this representation should be the default for the view
|
|
14
|
-
*/
|
|
15
|
-
is_default?: boolean;
|
|
16
|
-
/**
|
|
17
|
-
* Settings for the dashboard view representation
|
|
18
|
-
*
|
|
19
|
-
* @nullable true
|
|
20
|
-
*/
|
|
21
|
-
settings?: object;
|
|
22
|
-
/**
|
|
23
|
-
* Fields mapping for the dashboard view representation
|
|
24
|
-
*
|
|
25
|
-
* @nullable true
|
|
26
|
-
*/
|
|
27
|
-
fields_map?: object;
|
|
28
|
-
}
|
|
29
|
-
export interface CreateDashboardViewRepresentationTemplateRequestContract {
|
|
30
|
-
/**
|
|
31
|
-
* Unique identifier for the template
|
|
32
|
-
*
|
|
33
|
-
* @format uuid
|
|
34
|
-
*/
|
|
35
|
-
global_id: string;
|
|
36
|
-
/**
|
|
37
|
-
* Template name
|
|
38
|
-
*/
|
|
39
|
-
name: string;
|
|
40
|
-
/**
|
|
41
|
-
* Type of template (managed or custom)
|
|
42
|
-
*
|
|
43
|
-
* @enum "managed", "custom"
|
|
44
|
-
*/
|
|
45
|
-
type: "managed" | "custom";
|
|
46
|
-
/**
|
|
47
|
-
* Scope type for the template (required for custom templates)
|
|
48
|
-
*
|
|
49
|
-
* @enum "org"
|
|
50
|
-
*/
|
|
51
|
-
scope_type?: "org";
|
|
52
|
-
/**
|
|
53
|
-
* Scope ID for the template (required for custom templates)
|
|
54
|
-
*/
|
|
55
|
-
scope_id?: string;
|
|
56
|
-
}
|
|
57
|
-
export interface CreateDashboardViewRepresentationTemplateResponseContract extends StandardApiResponseContract {
|
|
58
|
-
data?: DashboardViewRepresentationTemplateContract;
|
|
59
|
-
}
|
|
60
|
-
export interface CreateDashboardViewRequestContract {
|
|
61
|
-
/**
|
|
62
|
-
* @format uuid
|
|
63
|
-
*/
|
|
64
|
-
global_id: string;
|
|
65
|
-
alias?: AliasContract;
|
|
66
|
-
/**
|
|
67
|
-
* @format uuid
|
|
68
|
-
*/
|
|
69
|
-
dashboard_id: string;
|
|
70
|
-
/**
|
|
71
|
-
* @minLength 1
|
|
72
|
-
* @maxLength 255
|
|
73
|
-
*/
|
|
74
|
-
name: string;
|
|
75
|
-
schema: DashboardSchemaContract;
|
|
76
|
-
filters: FilterConfigContract;
|
|
77
|
-
metadata?: DashboardMetadataContract;
|
|
78
|
-
/**
|
|
79
|
-
* @default false
|
|
80
|
-
*/
|
|
81
|
-
default_view?: boolean;
|
|
82
|
-
}
|
|
83
|
-
export interface DashboardViewContract extends DashboardViewRefContract, DashboardViewPropertiesContract, DashboardViewExpandedContract {
|
|
84
|
-
}
|
|
85
|
-
export interface DashboardViewExpandedContract {
|
|
86
|
-
/**
|
|
87
|
-
* List of representations associated with this view
|
|
88
|
-
*/
|
|
89
|
-
representations?: DashboardViewRepresentationSummaryContract[];
|
|
90
|
-
/**
|
|
91
|
-
* @nullable true
|
|
92
|
-
*/
|
|
93
|
-
dashboard?: DashboardRefContract;
|
|
94
|
-
}
|
|
95
|
-
export interface DashboardViewItemContract {
|
|
96
|
-
/**
|
|
97
|
-
* @format uuid
|
|
98
|
-
*/
|
|
99
|
-
global_id: string;
|
|
100
|
-
alias?: AliasContract;
|
|
101
|
-
name: string;
|
|
102
|
-
default_view: boolean;
|
|
103
|
-
order: number;
|
|
104
|
-
metadata: DashboardMetadataContract;
|
|
105
|
-
}
|
|
106
|
-
export type DashboardViewList = DashboardViewItemContract[];
|
|
107
|
-
export interface DashboardViewListResponseContract extends StandardApiResponseContract {
|
|
108
|
-
data?: DashboardViewList;
|
|
109
|
-
}
|
|
110
|
-
export interface DashboardViewPropertiesContract {
|
|
111
|
-
schema: DashboardSchemaContract;
|
|
112
|
-
filters: FilterConfigContract;
|
|
113
|
-
metadata: DashboardMetadataContract;
|
|
114
|
-
/**
|
|
115
|
-
* @format date-time
|
|
116
|
-
*/
|
|
117
|
-
created_at: Date;
|
|
118
|
-
/**
|
|
119
|
-
* @format date-time
|
|
120
|
-
*/
|
|
121
|
-
updated_at: Date;
|
|
122
|
-
/**
|
|
123
|
-
* @format date-time
|
|
124
|
-
* @nullable true
|
|
125
|
-
*/
|
|
126
|
-
deleted_at?: Date | null;
|
|
127
|
-
}
|
|
128
|
-
export interface DashboardViewRefContract {
|
|
129
|
-
/**
|
|
130
|
-
* Unique identifier for the dashboard view
|
|
131
|
-
*
|
|
132
|
-
* @format uuid
|
|
133
|
-
*/
|
|
134
|
-
global_id: string;
|
|
135
|
-
alias?: AliasContract;
|
|
136
|
-
/**
|
|
137
|
-
* Reference to the parent dashboard
|
|
138
|
-
*
|
|
139
|
-
* @format uuid
|
|
140
|
-
*/
|
|
141
|
-
dashboard_id: string;
|
|
142
|
-
/**
|
|
143
|
-
* Dashboard view name
|
|
144
|
-
*/
|
|
145
|
-
name: string;
|
|
146
|
-
/**
|
|
147
|
-
* Whether this is the default view for the dashboard
|
|
148
|
-
*/
|
|
149
|
-
default_view: boolean;
|
|
150
|
-
}
|
|
151
|
-
export interface DashboardViewRepresentationSummaryContract {
|
|
152
|
-
/**
|
|
153
|
-
* Settings for the dashboard view representation instance
|
|
154
|
-
*
|
|
155
|
-
* @nullable true
|
|
156
|
-
*/
|
|
157
|
-
settings: object;
|
|
158
|
-
/**
|
|
159
|
-
* Fields mapping for the dashboard view representation instance
|
|
160
|
-
*
|
|
161
|
-
* @nullable true
|
|
162
|
-
*/
|
|
163
|
-
fields_map: object;
|
|
164
|
-
/**
|
|
165
|
-
* Unique identifier for the representation template (shortcut to template.global_id)
|
|
166
|
-
*
|
|
167
|
-
* @format uuid
|
|
168
|
-
* @nullable true
|
|
169
|
-
*/
|
|
170
|
-
global_id: string | null;
|
|
171
|
-
/**
|
|
172
|
-
* Name of the representation template (shortcut to template.name)
|
|
173
|
-
*
|
|
174
|
-
* @nullable true
|
|
175
|
-
*/
|
|
176
|
-
name?: string | null;
|
|
177
|
-
/**
|
|
178
|
-
* Type of the representation template (shortcut to template.type)
|
|
179
|
-
*
|
|
180
|
-
* @nullable true
|
|
181
|
-
* @enum "managed", "custom"
|
|
182
|
-
*/
|
|
183
|
-
type: "managed" | "custom";
|
|
184
|
-
/**
|
|
185
|
-
* Whether this representation is the default for the view
|
|
186
|
-
*/
|
|
187
|
-
is_default: boolean;
|
|
188
|
-
}
|
|
189
|
-
export interface DashboardViewRepresentationTemplateContract {
|
|
190
|
-
/**
|
|
191
|
-
* Internal database ID
|
|
192
|
-
*/
|
|
193
|
-
id: number;
|
|
194
|
-
/**
|
|
195
|
-
* Unique identifier for the template
|
|
196
|
-
*
|
|
197
|
-
* @format uuid
|
|
198
|
-
*/
|
|
199
|
-
global_id: string;
|
|
200
|
-
/**
|
|
201
|
-
* Template name
|
|
202
|
-
*/
|
|
203
|
-
name: string;
|
|
204
|
-
/**
|
|
205
|
-
* Type of template (managed or custom)
|
|
206
|
-
*
|
|
207
|
-
* @enum "managed", "custom"
|
|
208
|
-
*/
|
|
209
|
-
type: "managed" | "custom";
|
|
210
|
-
/**
|
|
211
|
-
* Creation timestamp
|
|
212
|
-
*
|
|
213
|
-
* @format date-time
|
|
214
|
-
*/
|
|
215
|
-
created_at: Date;
|
|
216
|
-
/**
|
|
217
|
-
* Last update timestamp
|
|
218
|
-
*
|
|
219
|
-
* @format date-time
|
|
220
|
-
*/
|
|
221
|
-
updated_at: Date;
|
|
222
|
-
/**
|
|
223
|
-
* Soft deletion timestamp
|
|
224
|
-
*
|
|
225
|
-
* @format date-time
|
|
226
|
-
* @nullable true
|
|
227
|
-
*/
|
|
228
|
-
deleted_at?: Date | null;
|
|
229
|
-
}
|
|
230
|
-
export interface DashboardViewRepresentationTemplateListResponseContract extends StandardApiResponseContract {
|
|
231
|
-
data?: DashboardViewRepresentationTemplateContract[];
|
|
232
|
-
}
|
|
233
|
-
export interface DashboardViewResponseContract extends StandardApiResponseContract {
|
|
234
|
-
data?: DashboardViewContract;
|
|
235
|
-
}
|
|
236
|
-
export interface UpdateDashboardViewFiltersRequestContract {
|
|
237
|
-
filters: FilterConfigContract;
|
|
238
|
-
}
|
|
239
|
-
export interface UpdateDashboardViewRequestContract {
|
|
240
|
-
/**
|
|
241
|
-
* @minLength 1
|
|
242
|
-
* @maxLength 255
|
|
243
|
-
*/
|
|
244
|
-
name?: string;
|
|
245
|
-
alias?: AliasContract;
|
|
246
|
-
schema?: DashboardSchemaContract;
|
|
247
|
-
metadata?: DashboardMetadataContract;
|
|
248
|
-
default_view?: boolean;
|
|
249
|
-
}
|
|
@@ -1,203 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Database Schemas
|
|
3
|
-
*
|
|
4
|
-
* Generated from OpenAPI specification
|
|
5
|
-
* Source: schemas/database/database.yaml
|
|
6
|
-
*/
|
|
7
|
-
import type { DashboardItemContract } from "../dashboard/dashboard";
|
|
8
|
-
import type { AliasContract, GlobalIdsToReplaceMapContract, ScopeContract, ScopeOrgContract, StandardApiResponseContract } from "../shared/common";
|
|
9
|
-
export interface CopyDatabaseFromDatabaseRequestContract {
|
|
10
|
-
/**
|
|
11
|
-
* ID of the database to copy from
|
|
12
|
-
*
|
|
13
|
-
* @format uuid
|
|
14
|
-
*/
|
|
15
|
-
source_database_id: string;
|
|
16
|
-
/**
|
|
17
|
-
* New database ID
|
|
18
|
-
*
|
|
19
|
-
* @format uuid
|
|
20
|
-
*/
|
|
21
|
-
global_id: string;
|
|
22
|
-
alias?: AliasContract;
|
|
23
|
-
/**
|
|
24
|
-
* Optional new title (defaults to source title)
|
|
25
|
-
*/
|
|
26
|
-
title?: string;
|
|
27
|
-
/**
|
|
28
|
-
* Required new scopes for the copied database, org scope required
|
|
29
|
-
*/
|
|
30
|
-
scopes: ScopeContract[];
|
|
31
|
-
/**
|
|
32
|
-
* Include dashboard values/data in the copy
|
|
33
|
-
*
|
|
34
|
-
* @default false
|
|
35
|
-
*/
|
|
36
|
-
include_data?: boolean;
|
|
37
|
-
/**
|
|
38
|
-
* Optional predefined mapping of old global IDs to new global IDs
|
|
39
|
-
*/
|
|
40
|
-
global_ids_to_replace_map?: GlobalIdsToReplaceMapContract;
|
|
41
|
-
}
|
|
42
|
-
export interface CreateDatabaseRequestContract {
|
|
43
|
-
/**
|
|
44
|
-
* Global unique identifier for the database
|
|
45
|
-
*
|
|
46
|
-
* @format uuid
|
|
47
|
-
*/
|
|
48
|
-
global_id: string;
|
|
49
|
-
alias?: AliasContract;
|
|
50
|
-
/**
|
|
51
|
-
* Database title
|
|
52
|
-
*/
|
|
53
|
-
title: string;
|
|
54
|
-
metadata: DatabaseMetadataContract;
|
|
55
|
-
/**
|
|
56
|
-
* Whether the database is public
|
|
57
|
-
*
|
|
58
|
-
* @default false
|
|
59
|
-
*/
|
|
60
|
-
is_public?: boolean;
|
|
61
|
-
/**
|
|
62
|
-
* org scope must be provided
|
|
63
|
-
*/
|
|
64
|
-
scopes: ScopeContract[];
|
|
65
|
-
}
|
|
66
|
-
export interface DatabaseContract extends DatabaseRefContract, DatabasePropertiesContract, DatabaseExpandedContract {
|
|
67
|
-
}
|
|
68
|
-
export interface DatabaseExpandedContract {
|
|
69
|
-
/**
|
|
70
|
-
* List of dashboards associated with the database
|
|
71
|
-
*/
|
|
72
|
-
dashboards?: DashboardItemContract[];
|
|
73
|
-
scopes?: ScopeContract[];
|
|
74
|
-
}
|
|
75
|
-
export interface DatabaseListResponseContract extends StandardApiResponseContract {
|
|
76
|
-
data?: DatabaseContract[];
|
|
77
|
-
}
|
|
78
|
-
export interface DatabaseMetadataContract {
|
|
79
|
-
/**
|
|
80
|
-
* Optional description of the database
|
|
81
|
-
*/
|
|
82
|
-
description?: string;
|
|
83
|
-
/**
|
|
84
|
-
* Icon identifier for the database
|
|
85
|
-
*
|
|
86
|
-
* @default "default"
|
|
87
|
-
*/
|
|
88
|
-
icon?: string;
|
|
89
|
-
/**
|
|
90
|
-
* Whether the database is marked as favorite
|
|
91
|
-
*
|
|
92
|
-
* @default false
|
|
93
|
-
*/
|
|
94
|
-
favorite?: boolean;
|
|
95
|
-
/**
|
|
96
|
-
* Color identifier (will be used as Tailwind class on frontend)
|
|
97
|
-
*/
|
|
98
|
-
color?: string;
|
|
99
|
-
}
|
|
100
|
-
export interface DatabasePropertiesContract {
|
|
101
|
-
metadata: DatabaseMetadataContract;
|
|
102
|
-
/**
|
|
103
|
-
* Creation timestamp
|
|
104
|
-
*
|
|
105
|
-
* @format date-time
|
|
106
|
-
*/
|
|
107
|
-
created_at: Date;
|
|
108
|
-
/**
|
|
109
|
-
* Last update timestamp
|
|
110
|
-
*
|
|
111
|
-
* @format date-time
|
|
112
|
-
*/
|
|
113
|
-
updated_at: Date;
|
|
114
|
-
/**
|
|
115
|
-
* Soft delete timestamp
|
|
116
|
-
*
|
|
117
|
-
* @format date-time
|
|
118
|
-
* @nullable true
|
|
119
|
-
*/
|
|
120
|
-
deleted_at?: Date | null;
|
|
121
|
-
}
|
|
122
|
-
export interface DatabaseRefContract {
|
|
123
|
-
/**
|
|
124
|
-
* Global unique identifier for the database
|
|
125
|
-
*
|
|
126
|
-
* @format uuid
|
|
127
|
-
*/
|
|
128
|
-
global_id: string;
|
|
129
|
-
alias?: AliasContract;
|
|
130
|
-
/**
|
|
131
|
-
* Database title
|
|
132
|
-
*/
|
|
133
|
-
title: string;
|
|
134
|
-
/**
|
|
135
|
-
* Whether the database is public
|
|
136
|
-
*
|
|
137
|
-
* @default false
|
|
138
|
-
*/
|
|
139
|
-
is_public?: boolean;
|
|
140
|
-
}
|
|
141
|
-
export interface DatabaseResponseContract extends StandardApiResponseContract {
|
|
142
|
-
data?: DatabaseContract;
|
|
143
|
-
}
|
|
144
|
-
export interface GetOrCreateDatabaseRequestContract {
|
|
145
|
-
/**
|
|
146
|
-
* Optional template globalId (mutually exclusive with template_alias)
|
|
147
|
-
*
|
|
148
|
-
* @format uuid
|
|
149
|
-
*/
|
|
150
|
-
template_id?: string;
|
|
151
|
-
/**
|
|
152
|
-
* Optional template alias (mutually exclusive with template_id). Searches in template_scope first, then org scope from scopes array, then system org (from SYSTEM_ORG_SCOPE_ID env var).
|
|
153
|
-
*/
|
|
154
|
-
template_alias?: AliasContract;
|
|
155
|
-
/**
|
|
156
|
-
* Optional org scope to search for template. If provided, org scope will be extracted from here first.
|
|
157
|
-
*/
|
|
158
|
-
template_scope?: ScopeOrgContract;
|
|
159
|
-
/**
|
|
160
|
-
* Optional predefined mapping of old global IDs to new global IDs (for template-based creation)
|
|
161
|
-
*/
|
|
162
|
-
global_ids_to_replace_map?: GlobalIdsToReplaceMapContract;
|
|
163
|
-
/**
|
|
164
|
-
* Additional target scopes to add to the database
|
|
165
|
-
*/
|
|
166
|
-
additional_target_scopes?: ScopeContract[];
|
|
167
|
-
/**
|
|
168
|
-
* List of dashboard aliases to exclude from copying when creating database from template
|
|
169
|
-
*/
|
|
170
|
-
exclude_dashboard_aliases?: string[];
|
|
171
|
-
}
|
|
172
|
-
export interface GetOrCreateDatabaseResponseContract extends StandardApiResponseContract {
|
|
173
|
-
/**
|
|
174
|
-
* true if created, false if found
|
|
175
|
-
*/
|
|
176
|
-
created?: boolean;
|
|
177
|
-
data?: DatabaseContract;
|
|
178
|
-
}
|
|
179
|
-
export interface ImportDatabaseRequestContract {
|
|
180
|
-
/**
|
|
181
|
-
* Required scopes for the imported database, org scope required
|
|
182
|
-
*/
|
|
183
|
-
scopes: ScopeContract[];
|
|
184
|
-
/**
|
|
185
|
-
* @format uuid
|
|
186
|
-
*/
|
|
187
|
-
global_id?: string;
|
|
188
|
-
alias?: AliasContract;
|
|
189
|
-
title?: string;
|
|
190
|
-
metadata?: DatabaseMetadataContract;
|
|
191
|
-
}
|
|
192
|
-
export interface UpdateDatabaseRequestContract {
|
|
193
|
-
/**
|
|
194
|
-
* Database title
|
|
195
|
-
*/
|
|
196
|
-
title?: string;
|
|
197
|
-
alias?: AliasContract;
|
|
198
|
-
/**
|
|
199
|
-
* Whether the database is public
|
|
200
|
-
*/
|
|
201
|
-
is_public?: boolean;
|
|
202
|
-
metadata?: DatabaseMetadataContract;
|
|
203
|
-
}
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Relations Schemas
|
|
3
|
-
*
|
|
4
|
-
* Generated from OpenAPI specification
|
|
5
|
-
* Source: schemas/relations/relations.yaml
|
|
6
|
-
*/
|
|
7
|
-
import type { DashboardContract } from "../dashboard/dashboard";
|
|
8
|
-
import type { StandardApiResponseContract } from "../shared/common";
|
|
9
|
-
export interface AddRelationRowsRequestContract {
|
|
10
|
-
/**
|
|
11
|
-
* Row mappings to add. Each item has source_index (row in source dashboard) and target_index (row in target dashboard). Does not remove existing mappings.
|
|
12
|
-
*/
|
|
13
|
-
rows: CreateRelationRowRequestContract[];
|
|
14
|
-
}
|
|
15
|
-
export interface CreateDashboardRelationRequestContract {
|
|
16
|
-
/**
|
|
17
|
-
* Dashboard you fetch lookup data FROM (the table whose columns are displayed in relation/lookup columns).
|
|
18
|
-
*
|
|
19
|
-
* @format uuid
|
|
20
|
-
*/
|
|
21
|
-
source_dashboard_id: string;
|
|
22
|
-
/**
|
|
23
|
-
* Dashboard you are ON (the view where relation/lookup columns live).
|
|
24
|
-
*
|
|
25
|
-
* @format uuid
|
|
26
|
-
*/
|
|
27
|
-
target_dashboard_id: string;
|
|
28
|
-
relation_type: RelationTypeContract;
|
|
29
|
-
}
|
|
30
|
-
export interface CreateRelationRowRequestContract {
|
|
31
|
-
/**
|
|
32
|
-
* Row ID in the source dashboard (dashboard you fetch lookup data FROM). Use root_index_value from getDashboardViewData.
|
|
33
|
-
*/
|
|
34
|
-
source_index: string;
|
|
35
|
-
/**
|
|
36
|
-
* Row ID in the target dashboard (dashboard where relation/lookup columns live). Use root_index_value from getDashboardViewData.
|
|
37
|
-
*/
|
|
38
|
-
target_index: string;
|
|
39
|
-
}
|
|
40
|
-
export interface DashboardRelationContract {
|
|
41
|
-
/**
|
|
42
|
-
* Relation UUID. Use in updateViewIntent relations[].relation_id and addRelationRows/updateRelationRows.
|
|
43
|
-
*
|
|
44
|
-
* @format uuid
|
|
45
|
-
*/
|
|
46
|
-
global_id: string;
|
|
47
|
-
/**
|
|
48
|
-
* Dashboard you fetch lookup data FROM (the table whose columns are displayed in relation/lookup columns).
|
|
49
|
-
*
|
|
50
|
-
* @format uuid
|
|
51
|
-
*/
|
|
52
|
-
source_dashboard_id: string;
|
|
53
|
-
/**
|
|
54
|
-
* Dashboard you are ON (the view where relation/lookup columns live).
|
|
55
|
-
*
|
|
56
|
-
* @format uuid
|
|
57
|
-
*/
|
|
58
|
-
target_dashboard_id: string;
|
|
59
|
-
relation_type: RelationTypeContract;
|
|
60
|
-
/**
|
|
61
|
-
* @format date-time
|
|
62
|
-
*/
|
|
63
|
-
created_at: Date;
|
|
64
|
-
/**
|
|
65
|
-
* @format date-time
|
|
66
|
-
*/
|
|
67
|
-
updated_at: Date;
|
|
68
|
-
/**
|
|
69
|
-
* @format date-time
|
|
70
|
-
* @nullable true
|
|
71
|
-
*/
|
|
72
|
-
deleted_at?: Date | null;
|
|
73
|
-
/**
|
|
74
|
-
* Pairs of source_index (row in source dashboard) and target_index (row in target dashboard) linking rows.
|
|
75
|
-
*/
|
|
76
|
-
relation_rows?: DashboardRelationRowContract[];
|
|
77
|
-
source_dashboard?: DashboardContract;
|
|
78
|
-
target_dashboard?: DashboardContract;
|
|
79
|
-
}
|
|
80
|
-
export interface DashboardRelationListResponseContract extends StandardApiResponseContract {
|
|
81
|
-
data?: DashboardRelationContract[];
|
|
82
|
-
}
|
|
83
|
-
export interface DashboardRelationResponseContract extends StandardApiResponseContract {
|
|
84
|
-
data?: DashboardRelationContract;
|
|
85
|
-
}
|
|
86
|
-
export interface DashboardRelationRowContract {
|
|
87
|
-
/**
|
|
88
|
-
* Auto-incrementing primary key
|
|
89
|
-
*/
|
|
90
|
-
id: number;
|
|
91
|
-
/**
|
|
92
|
-
* Relation UUID (global_id from createDashboardRelation).
|
|
93
|
-
*
|
|
94
|
-
* @format uuid
|
|
95
|
-
*/
|
|
96
|
-
relation_id: string;
|
|
97
|
-
/**
|
|
98
|
-
* Row ID in the source dashboard (dashboard you fetch lookup data FROM).
|
|
99
|
-
*/
|
|
100
|
-
source_index: string;
|
|
101
|
-
/**
|
|
102
|
-
* Row ID in the target dashboard (dashboard where relation/lookup columns live).
|
|
103
|
-
*/
|
|
104
|
-
target_index: string;
|
|
105
|
-
/**
|
|
106
|
-
* @format date-time
|
|
107
|
-
*/
|
|
108
|
-
created_at: Date;
|
|
109
|
-
/**
|
|
110
|
-
* @format date-time
|
|
111
|
-
*/
|
|
112
|
-
updated_at: Date;
|
|
113
|
-
/**
|
|
114
|
-
* @format date-time
|
|
115
|
-
* @nullable true
|
|
116
|
-
*/
|
|
117
|
-
deleted_at?: Date | null;
|
|
118
|
-
}
|
|
119
|
-
/**
|
|
120
|
-
* one_to_one - one source row ↔ one target row.
|
|
121
|
-
* one_to_many - one source row can link to many target rows (e.g. Author → Books).
|
|
122
|
-
* many_to_many - many-to-many (e.g. Tags ↔ Content).
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* @enum "one_to_one", "one_to_many", "many_to_many"
|
|
126
|
-
*/
|
|
127
|
-
export type RelationTypeContract = "one_to_one" | "one_to_many" | "many_to_many";
|
|
128
|
-
export interface UpdateRelationRowsRequestContract {
|
|
129
|
-
/**
|
|
130
|
-
* Replaces only the mappings for the target_index values present in this array; other existing mappings are unchanged.
|
|
131
|
-
*/
|
|
132
|
-
rows: CreateRelationRowRequestContract[];
|
|
133
|
-
}
|
|
134
|
-
export declare const RelationTypeContract: {
|
|
135
|
-
readonly OneToOne: "one_to_one";
|
|
136
|
-
readonly OneToMany: "one_to_many";
|
|
137
|
-
readonly ManyToMany: "many_to_many";
|
|
138
|
-
};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* Relations Schemas
|
|
4
|
-
*
|
|
5
|
-
* Generated from OpenAPI specification
|
|
6
|
-
* Source: schemas/relations/relations.yaml
|
|
7
|
-
*/
|
|
8
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.RelationTypeContract = void 0;
|
|
10
|
-
exports.RelationTypeContract = {
|
|
11
|
-
OneToOne: "one_to_one",
|
|
12
|
-
OneToMany: "one_to_many",
|
|
13
|
-
ManyToMany: "many_to_many"
|
|
14
|
-
};
|