revisium 2.0.1 → 2.2.0

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 (97) hide show
  1. package/.github/workflows/ci.yml +32 -0
  2. package/README.md +23 -3
  3. package/dist/e2e/setup/global-setup.js +2 -3
  4. package/dist/e2e/setup/global-setup.js.map +1 -1
  5. package/dist/e2e/setup/global-teardown.js +0 -2
  6. package/dist/e2e/setup/global-teardown.js.map +1 -1
  7. package/dist/e2e/utils/constants.d.ts +0 -2
  8. package/dist/e2e/utils/constants.js +0 -2
  9. package/dist/e2e/utils/constants.js.map +1 -1
  10. package/dist/e2e/utils/docker-helper.d.ts +0 -2
  11. package/dist/e2e/utils/docker-helper.js +0 -13
  12. package/dist/e2e/utils/docker-helper.js.map +1 -1
  13. package/dist/package.json +27 -14
  14. package/dist/src/commands/migration/apply-migrations.command.d.ts +1 -1
  15. package/dist/src/commands/migration/apply-migrations.command.js +4 -5
  16. package/dist/src/commands/migration/apply-migrations.command.js.map +1 -1
  17. package/dist/src/commands/migration/save-migrations.command.d.ts +1 -1
  18. package/dist/src/commands/migration/save-migrations.command.js +6 -6
  19. package/dist/src/commands/migration/save-migrations.command.js.map +1 -1
  20. package/dist/src/commands/rows/save-rows.command.d.ts +1 -1
  21. package/dist/src/commands/rows/save-rows.command.js +12 -10
  22. package/dist/src/commands/rows/save-rows.command.js.map +1 -1
  23. package/dist/src/commands/rows/upload-rows.command.d.ts +1 -1
  24. package/dist/src/commands/rows/upload-rows.command.js +12 -15
  25. package/dist/src/commands/rows/upload-rows.command.js.map +1 -1
  26. package/dist/src/commands/schema/create-migrations.command.js.map +1 -1
  27. package/dist/src/commands/schema/save-schema.command.d.ts +1 -1
  28. package/dist/src/commands/schema/save-schema.command.js +7 -7
  29. package/dist/src/commands/schema/save-schema.command.js.map +1 -1
  30. package/dist/src/config/meta-schema.d.ts +3 -0
  31. package/dist/src/config/meta-schema.js +43 -1
  32. package/dist/src/config/meta-schema.js.map +1 -1
  33. package/dist/src/services/connection/api-client-adapter.d.ts +2 -4
  34. package/dist/src/services/connection/api-client-adapter.js +40 -36
  35. package/dist/src/services/connection/api-client-adapter.js.map +1 -1
  36. package/dist/src/services/connection/api-client.d.ts +3 -4
  37. package/dist/src/services/connection/api-client.js +11 -33
  38. package/dist/src/services/connection/api-client.js.map +1 -1
  39. package/dist/src/services/connection/connection-factory.service.d.ts +4 -6
  40. package/dist/src/services/connection/connection-factory.service.js +18 -39
  41. package/dist/src/services/connection/connection-factory.service.js.map +1 -1
  42. package/dist/src/services/connection/connection.service.d.ts +2 -73
  43. package/dist/src/services/connection/connection.service.js +2 -11
  44. package/dist/src/services/connection/connection.service.js.map +1 -1
  45. package/dist/src/services/sync/commit-revision.service.js +6 -28
  46. package/dist/src/services/sync/commit-revision.service.js.map +1 -1
  47. package/dist/src/services/sync/row-sync.service.d.ts +5 -5
  48. package/dist/src/services/sync/row-sync.service.js +10 -10
  49. package/dist/src/services/sync/row-sync.service.js.map +1 -1
  50. package/dist/src/services/sync/sync-data.service.d.ts +1 -0
  51. package/dist/src/services/sync/sync-data.service.js +21 -21
  52. package/dist/src/services/sync/sync-data.service.js.map +1 -1
  53. package/dist/src/services/sync/sync-schema.service.d.ts +1 -0
  54. package/dist/src/services/sync/sync-schema.service.js +11 -10
  55. package/dist/src/services/sync/sync-schema.service.js.map +1 -1
  56. package/dist/src/services/url/auth-prompt.service.js +1 -1
  57. package/dist/src/services/url/auth-prompt.service.js.map +1 -1
  58. package/dist/src/types/migration.types.d.ts +1 -1
  59. package/dist/tsconfig.build.tsbuildinfo +1 -1
  60. package/docs/authentication.md +3 -3
  61. package/docs/configuration.md +58 -9
  62. package/docs/docker-deployment.md +48 -13
  63. package/docs/migrate-commands.md +35 -10
  64. package/docs/rows-commands.md +30 -7
  65. package/docs/schema-commands.md +21 -5
  66. package/docs/sync-commands.md +44 -12
  67. package/docs/url-format.md +2 -2
  68. package/e2e/setup/global-setup.ts +3 -9
  69. package/e2e/setup/global-teardown.ts +0 -6
  70. package/e2e/utils/constants.ts +0 -2
  71. package/e2e/utils/docker-helper.ts +0 -23
  72. package/package.json +27 -14
  73. package/src/commands/migration/apply-migrations.command.ts +5 -6
  74. package/src/commands/migration/save-migrations.command.ts +7 -6
  75. package/src/commands/rows/save-rows.command.ts +14 -28
  76. package/src/commands/rows/upload-rows.command.ts +7 -15
  77. package/src/commands/schema/create-migrations.command.ts +1 -1
  78. package/src/commands/schema/save-schema.command.ts +9 -14
  79. package/src/config/meta-schema.ts +47 -0
  80. package/src/services/connection/__tests__/connection-factory.service.spec.ts +117 -0
  81. package/src/services/connection/__tests__/connection.service.spec.ts +27 -117
  82. package/src/services/connection/api-client-adapter.ts +41 -45
  83. package/src/services/connection/api-client.ts +11 -50
  84. package/src/services/connection/connection-factory.service.ts +35 -65
  85. package/src/services/connection/connection.service.ts +3 -14
  86. package/src/services/sync/__tests__/row-sync.service.spec.ts +3 -6
  87. package/src/services/sync/commit-revision.service.ts +7 -51
  88. package/src/services/sync/row-sync.service.ts +4 -18
  89. package/src/services/sync/sync-data.service.ts +32 -45
  90. package/src/services/sync/sync-schema.service.ts +14 -22
  91. package/src/services/url/auth-prompt.service.ts +1 -1
  92. package/src/types/migration.types.ts +2 -2
  93. package/dist/src/__generated__/api.d.ts +0 -688
  94. package/dist/src/__generated__/api.js +0 -698
  95. package/dist/src/__generated__/api.js.map +0 -1
  96. package/e2e/docker-compose.e2e.yml +0 -31
  97. package/src/__generated__/api.ts +0 -2598
@@ -1,2598 +0,0 @@
1
- /* eslint-disable */
2
- /* tslint:disable */
3
- // @ts-nocheck
4
- /*
5
- * ---------------------------------------------------------------
6
- * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
7
- * ## ##
8
- * ## AUTHOR: acacode ##
9
- * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
10
- * ---------------------------------------------------------------
11
- */
12
-
13
- export interface LoginDto {
14
- emailOrUsername: string;
15
- password: string;
16
- }
17
-
18
- export interface LoginResponse {
19
- accessToken: string;
20
- }
21
-
22
- export interface CreateUserDto {
23
- username: string;
24
- roleId: "systemAdmin" | "systemFullApiRead" | "systemUser";
25
- password: string;
26
- email?: string;
27
- }
28
-
29
- export interface UpdatePasswordDto {
30
- oldPassword: string;
31
- newPassword: string;
32
- }
33
-
34
- export interface UserModel {
35
- id: string;
36
- username?: string;
37
- email?: string;
38
- }
39
-
40
- export interface ProjectModel {
41
- id: string;
42
- organizationId: string;
43
- /** @format date-time */
44
- createdAt: string;
45
- name: string;
46
- }
47
-
48
- export interface ProjectModelEdgeType {
49
- cursor: string;
50
- node: ProjectModel;
51
- }
52
-
53
- export interface PageInfo {
54
- endCursor?: string;
55
- hasNextPage: boolean;
56
- hasPreviousPage: boolean;
57
- startCursor?: string;
58
- }
59
-
60
- export interface ProjectsConnection {
61
- edges: ProjectModelEdgeType[];
62
- totalCount: number;
63
- pageInfo: PageInfo;
64
- }
65
-
66
- export interface CreateProjectDto {
67
- projectName: string;
68
- /** @default "master" */
69
- branchName?: string;
70
- }
71
-
72
- export interface RoleModel {
73
- id: string;
74
- name: string;
75
- }
76
-
77
- export interface UsersOrganizationModel {
78
- id: string;
79
- user: UserModel;
80
- role: RoleModel;
81
- }
82
-
83
- export interface UsersOrganizationModelEdgeType {
84
- cursor: string;
85
- node: UsersOrganizationModel;
86
- }
87
-
88
- export interface UsersOrganizationConnection {
89
- edges: UsersOrganizationModelEdgeType[];
90
- totalCount: number;
91
- pageInfo: PageInfo;
92
- }
93
-
94
- export interface AddUserToOrganizationDto {
95
- userId: string;
96
- roleId:
97
- | "organizationOwner"
98
- | "organizationAdmin"
99
- | "developer"
100
- | "editor"
101
- | "reader";
102
- }
103
-
104
- export interface RemoveUserFromOrganizationDto {
105
- userId: string;
106
- }
107
-
108
- export interface BranchModel {
109
- id: string;
110
- projectId: string;
111
- /** @format date-time */
112
- createdAt: string;
113
- isRoot: boolean;
114
- name: string;
115
- }
116
-
117
- export interface BranchModelEdgeType {
118
- cursor: string;
119
- node: BranchModel;
120
- }
121
-
122
- export interface BranchesConnection {
123
- edges: BranchModelEdgeType[];
124
- totalCount: number;
125
- pageInfo: PageInfo;
126
- }
127
-
128
- export interface SuccessModelDto {
129
- /** @example true */
130
- success: boolean;
131
- }
132
-
133
- export interface UpdateProjectDto {
134
- isPublic: boolean;
135
- }
136
-
137
- export interface UsersProjectModel {
138
- id: string;
139
- user: UserModel;
140
- role: RoleModel;
141
- }
142
-
143
- export interface UsersProjectModelEdgeType {
144
- cursor: string;
145
- node: UsersProjectModel;
146
- }
147
-
148
- export interface UsersProjectConnection {
149
- edges: UsersProjectModelEdgeType[];
150
- totalCount: number;
151
- pageInfo: PageInfo;
152
- }
153
-
154
- export interface AddUserToProjectDto {
155
- userId: string;
156
- roleId: "developer" | "editor" | "reader";
157
- }
158
-
159
- export interface TouchedModelDto {
160
- /** @example true */
161
- touched: boolean;
162
- }
163
-
164
- export interface Id {
165
- id: string;
166
- }
167
-
168
- export interface ParentBranchResponse {
169
- branch: Id;
170
- revision: Id;
171
- }
172
-
173
- export interface RevisionModel {
174
- id: string;
175
- /** @format date-time */
176
- createdAt: string;
177
- isDraft: boolean;
178
- isHead: boolean;
179
- }
180
-
181
- export interface RevisionModelEdgeType {
182
- cursor: string;
183
- node: RevisionModel;
184
- }
185
-
186
- export interface RevisionsConnection {
187
- edges: RevisionModelEdgeType[];
188
- totalCount: number;
189
- pageInfo: PageInfo;
190
- }
191
-
192
- export interface CreateRevisionDto {
193
- /** @default "" */
194
- comment?: string;
195
- }
196
-
197
- export interface RemoveMigrationDto {
198
- /**
199
- * Indicates a remove migration
200
- * @example "remove"
201
- */
202
- changeType: "remove";
203
- /** Timestamp when the table was removed (ISO 8601) */
204
- id: string;
205
- /** Current table identifier */
206
- tableId: string;
207
- }
208
-
209
- export interface RenameMigrationDto {
210
- /**
211
- * Indicates a rename migration
212
- * @example "rename"
213
- */
214
- changeType: "rename";
215
- /** Timestamp when the table was renamed (ISO 8601) */
216
- id: string;
217
- /** Current table identifier */
218
- tableId: string;
219
- /** New table identifier after renaming */
220
- nextTableId: string;
221
- }
222
-
223
- export interface UpdateMigrationDto {
224
- /**
225
- * Indicates an update migration
226
- * @example "update"
227
- */
228
- changeType: "update";
229
- /** Identifier of the table */
230
- tableId: string;
231
- /** Checksum of the patch set */
232
- hash: string;
233
- /** Timestamp when the update was applied (ISO 8601) */
234
- id: string;
235
- /** Array of JSON Patch operations */
236
- patches: object[];
237
- }
238
-
239
- export interface InitMigrationDto {
240
- /**
241
- * Indicates an initialization migration
242
- * @example "init"
243
- */
244
- changeType: "init";
245
- /** Identifier of the newly created table */
246
- tableId: string;
247
- /** Checksum of the initial schema */
248
- hash: string;
249
- /**
250
- * Timestamp when the table was created (ISO 8601)
251
- * @example "2025-07-31T12:34:56Z"
252
- */
253
- id: string;
254
- /** JSON Schema definition of the table */
255
- schema: object;
256
- }
257
-
258
- export interface ChildBranchResponse {
259
- branch: Id;
260
- revision: Id;
261
- }
262
-
263
- export interface TableModel {
264
- createdId: string;
265
- id: string;
266
- versionId: string;
267
- /** @format date-time */
268
- createdAt: string;
269
- /** @format date-time */
270
- updatedAt: string;
271
- readonly: boolean;
272
- }
273
-
274
- export interface TableModelEdgeType {
275
- cursor: string;
276
- node: TableModel;
277
- }
278
-
279
- export interface TablesConnection {
280
- edges: TableModelEdgeType[];
281
- totalCount: number;
282
- pageInfo: PageInfo;
283
- }
284
-
285
- export interface EndpointModel {
286
- id: string;
287
- /** @format date-time */
288
- createdAt: string;
289
- type: "GRAPHQL" | "REST_API";
290
- }
291
-
292
- export interface CreateBranchByRevisionDto {
293
- branchName: string;
294
- }
295
-
296
- export interface CreateEndpointDto {
297
- type: "GRAPHQL" | "REST_API";
298
- }
299
-
300
- export interface CreateTableDto {
301
- tableId: string;
302
- schema: Record<string, any>;
303
- }
304
-
305
- export interface CreateTableResponse {
306
- branch: BranchModel;
307
- table: TableModel;
308
- }
309
-
310
- export interface ApplyMigrationsResponseDto {
311
- /** The ID of the migration */
312
- id: string;
313
- /** The migration application status */
314
- status: "applied" | "failed" | "skipped";
315
- /** Error message if the migration failed */
316
- error?: string;
317
- }
318
-
319
- export interface OrderByDto {
320
- field: "createdAt" | "updatedAt" | "publishedAt" | "id" | "data";
321
- direction: "asc" | "desc";
322
- path?: string;
323
- type?: "text" | "int" | "float" | "boolean" | "timestamp";
324
- aggregation?: "min" | "max" | "avg" | "first" | "last";
325
- }
326
-
327
- export interface StringFilterDto {
328
- equals?: string;
329
- in?: string[];
330
- notIn?: string[];
331
- lt?: string;
332
- lte?: string;
333
- gt?: string;
334
- gte?: string;
335
- contains?: string;
336
- startsWith?: string;
337
- endsWith?: string;
338
- mode?: "default" | "insensitive";
339
- /** Negation filter (not): a simple string */
340
- not?: string;
341
- }
342
-
343
- export interface BoolFilterDto {
344
- equals?: boolean;
345
- /** Filter negation (not). */
346
- not?: BoolFilterDto | boolean;
347
- }
348
-
349
- export interface DateTimeFilterDto {
350
- /** @format date-time */
351
- equals?: string;
352
- in?: string[];
353
- notIn?: string[];
354
- /** @format date-time */
355
- lt?: string;
356
- /** @format date-time */
357
- lte?: string;
358
- /** @format date-time */
359
- gt?: string;
360
- /** @format date-time */
361
- gte?: string;
362
- }
363
-
364
- export interface JsonFilterDto {
365
- /** Exact JSON match */
366
- equals?: object;
367
- /** Path in JSON (PostgreSQL: array of keys/indexes, e.g. ["pet1","petName"] or dot notation "pet1.petName") */
368
- path?: string | string[];
369
- /** Case sensitivity mode for string filters within JSON ("insensitive" uses ILIKE on PostgreSQL) */
370
- mode?: "default" | "insensitive";
371
- /** Substring match in JSON string value */
372
- string_contains?: string;
373
- /** Prefix match in JSON string value */
374
- string_starts_with?: string;
375
- /** Suffix match in JSON string value */
376
- string_ends_with?: string;
377
- /** Filter on arrays: target JSON array must contain *all* of these values */
378
- array_contains?: object[];
379
- /** JSON value that the target JSON array must start with (could be object, array, primitive) */
380
- array_starts_with?: object;
381
- /** JSON value that the target JSON array must end with (could be object, array, primitive) */
382
- array_ends_with?: object;
383
- /** Less-than comparison. Must be a number or numeric JSON value */
384
- lt?: number;
385
- /** Less-than-or-equal comparison. Must be a number or numeric JSON value */
386
- lte?: number;
387
- /** Greater-than comparison. Must be a number or numeric JSON value */
388
- gt?: number;
389
- /** Greater-than-or-equal comparison. Must be a number or numeric JSON value */
390
- gte?: number;
391
- /** Full-text search string for JSON content */
392
- search?: string;
393
- /** Language for full-text search. Default: simple */
394
- searchLanguage?:
395
- | "simple"
396
- | "arabic"
397
- | "armenian"
398
- | "basque"
399
- | "catalan"
400
- | "danish"
401
- | "dutch"
402
- | "english"
403
- | "finnish"
404
- | "french"
405
- | "german"
406
- | "greek"
407
- | "hindi"
408
- | "hungarian"
409
- | "indonesian"
410
- | "irish"
411
- | "italian"
412
- | "lithuanian"
413
- | "nepali"
414
- | "norwegian"
415
- | "portuguese"
416
- | "romanian"
417
- | "russian"
418
- | "serbian"
419
- | "spanish"
420
- | "swedish"
421
- | "tamil"
422
- | "turkish"
423
- | "yiddish";
424
- /** Search type: plain (individual words), phrase (exact phrase), prefix (word beginnings with :*), tsquery (raw PostgreSQL tsquery syntax) */
425
- searchType?: "plain" | "phrase" | "prefix" | "tsquery";
426
- /** Scope of search within JSON structure */
427
- searchIn?: "all" | "values" | "keys" | "strings" | "numbers" | "booleans";
428
- }
429
-
430
- export interface RowWhereInputDto {
431
- /** AND conditions */
432
- AND?: RowWhereInputDto[];
433
- /** OR conditions */
434
- OR?: RowWhereInputDto[];
435
- /** NOT conditions */
436
- NOT?: RowWhereInputDto[];
437
- /** Filter by versionId */
438
- versionId?: StringFilterDto;
439
- /** Filter by createdId */
440
- createdId?: StringFilterDto;
441
- /** Filter by id */
442
- id?: StringFilterDto;
443
- /** Filter by readonly */
444
- readonly?: BoolFilterDto;
445
- /** Filter by createdAt */
446
- createdAt?: DateTimeFilterDto;
447
- /** Filter by updatedAt */
448
- updatedAt?: DateTimeFilterDto;
449
- /** Filter by publishedAt */
450
- publishedAt?: DateTimeFilterDto;
451
- /** Filter by data */
452
- data?: JsonFilterDto;
453
- /** Filter by meta */
454
- meta?: JsonFilterDto;
455
- /** Filter by hash */
456
- hash?: StringFilterDto;
457
- /** Filter by schemaHash */
458
- schemaHash?: StringFilterDto;
459
- }
460
-
461
- export interface GetTableRowsDto {
462
- /** @default 100 */
463
- first: number;
464
- /** @example "" */
465
- after?: string;
466
- /**
467
- * Array of sorting criteria
468
- * @example [{"field":"id","direction":"asc"}]
469
- */
470
- orderBy?: OrderByDto[];
471
- /** Row filtering conditions */
472
- where?: RowWhereInputDto;
473
- }
474
-
475
- export interface RowModel {
476
- createdId: string;
477
- id: string;
478
- versionId: string;
479
- /** @format date-time */
480
- createdAt: string;
481
- /** @format date-time */
482
- updatedAt: string;
483
- /** @format date-time */
484
- publishedAt: string;
485
- readonly: boolean;
486
- data: Record<string, any>;
487
- }
488
-
489
- export interface RowModelEdgeType {
490
- cursor: string;
491
- node: RowModel;
492
- }
493
-
494
- export interface RowsConnection {
495
- edges: RowModelEdgeType[];
496
- totalCount: number;
497
- pageInfo: PageInfo;
498
- }
499
-
500
- export interface CreateRowDto {
501
- rowId: string;
502
- data: Record<string, any>;
503
- isRestore?: boolean;
504
- }
505
-
506
- export interface CreateRowResponse {
507
- table: TableModel;
508
- previousVersionTableId: string;
509
- row: RowModel;
510
- }
511
-
512
- export interface CreateRowsRowDto {
513
- rowId: string;
514
- data: Record<string, any>;
515
- }
516
-
517
- export interface CreateRowsDto {
518
- /** @maxItems 1000 */
519
- rows: CreateRowsRowDto[];
520
- isRestore?: boolean;
521
- }
522
-
523
- export interface CreateRowsResponse {
524
- table: TableModel;
525
- previousVersionTableId: string;
526
- rows: RowModel[];
527
- }
528
-
529
- export interface UpdateRowsRowDto {
530
- rowId: string;
531
- data: Record<string, any>;
532
- }
533
-
534
- export interface UpdateRowsDto {
535
- /** @maxItems 1000 */
536
- rows: UpdateRowsRowDto[];
537
- isRestore?: boolean;
538
- }
539
-
540
- export interface UpdateRowsResponse {
541
- table: TableModel;
542
- previousVersionTableId: string;
543
- rows: RowModel[];
544
- }
545
-
546
- export interface PatchRow {
547
- /**
548
- * The operation to perform. Currently only "replace" is supported
549
- * @example "replace"
550
- */
551
- op: "replace";
552
- /**
553
- * JSON path using dot notation for objects and [index] for arrays. Examples: "name", "user.email", "items[0]", "data.list[2].value"
554
- * @example "list[0].nestedList[2].name"
555
- */
556
- path: string;
557
- /**
558
- * The value to set at the specified path. Can be any valid JSON value (string, number, boolean, object, array, or null)
559
- * @example "{ "key": "value" }"
560
- */
561
- value: string | number | boolean | object | any[] | null;
562
- }
563
-
564
- export interface PatchRowsRowDto {
565
- rowId: string;
566
- patches: PatchRow[];
567
- }
568
-
569
- export interface PatchRowsDto {
570
- /** @maxItems 1000 */
571
- rows: PatchRowsRowDto[];
572
- }
573
-
574
- export interface PatchRowsResponse {
575
- table: TableModel;
576
- previousVersionTableId: string;
577
- rows: RowModel[];
578
- }
579
-
580
- export interface RemoveRowsDto {
581
- /** @maxItems 1000 */
582
- rowIds: string[];
583
- }
584
-
585
- export interface RemoveRowsResponse {
586
- branch: BranchModel;
587
- table?: TableModel;
588
- previousVersionTableId?: string;
589
- }
590
-
591
- export interface UpdateTableDto {
592
- patches: object[];
593
- }
594
-
595
- export interface UpdateTableResponse {
596
- table?: TableModel;
597
- previousVersionTableId: string;
598
- }
599
-
600
- export interface ErrorModel {
601
- statusCode: number;
602
- message: string;
603
- error: string;
604
- }
605
-
606
- export interface RemoveRowResponse {
607
- branch: BranchModel;
608
- table?: TableModel;
609
- previousVersionTableId?: string;
610
- }
611
-
612
- export interface UpdateRowDto {
613
- data: Record<string, any>;
614
- isRestore?: boolean;
615
- }
616
-
617
- export interface UpdateRowResponse {
618
- table?: TableModel;
619
- previousVersionTableId?: string;
620
- row?: RowModel;
621
- previousVersionRowId?: string;
622
- }
623
-
624
- export interface PatchRowDto {
625
- patches: PatchRow[];
626
- }
627
-
628
- export interface PatchRowResponse {
629
- table?: TableModel;
630
- previousVersionTableId?: string;
631
- row?: RowModel;
632
- previousVersionRowId?: string;
633
- }
634
-
635
- export interface RenameRowDto {
636
- nextRowId: string;
637
- }
638
-
639
- export interface RenameRowResponse {
640
- table?: TableModel;
641
- previousVersionTableId?: string;
642
- row?: RowModel;
643
- previousVersionRowId?: string;
644
- }
645
-
646
- export interface UploadFileResponse {
647
- table?: TableModel;
648
- previousVersionTableId?: string;
649
- row?: RowModel;
650
- previousVersionRowId?: string;
651
- }
652
-
653
- export interface GetEndpointResultDto {
654
- endpoint: EndpointModel;
655
- revision: RevisionModel;
656
- branch: BranchModel;
657
- project: ProjectModel;
658
- }
659
-
660
- export interface GoogleOauth {
661
- available: boolean;
662
- clientId?: string;
663
- }
664
-
665
- export interface GithubOauth {
666
- available: boolean;
667
- clientId?: string;
668
- }
669
-
670
- export interface ConfigurationResponse {
671
- availableEmailSignUp: boolean;
672
- google: GoogleOauth;
673
- github: GithubOauth;
674
- }
675
-
676
- export interface ProjectsParams {
677
- /** @default 100 */
678
- first: number;
679
- after?: string;
680
- organizationId: string;
681
- }
682
-
683
- export interface CreateProjectParams {
684
- fromRevisionId: string;
685
- organizationId: string;
686
- }
687
-
688
- export interface UsersOrganizationParams {
689
- /** @default 100 */
690
- first: number;
691
- after?: string;
692
- organizationId: string;
693
- }
694
-
695
- export interface BranchesParams {
696
- /** @default 100 */
697
- first: number;
698
- after?: string;
699
- organizationId: string;
700
- projectName: string;
701
- }
702
-
703
- export interface UsersProjectParams {
704
- /** @default 100 */
705
- first: number;
706
- after?: string;
707
- organizationId: string;
708
- projectName: string;
709
- }
710
-
711
- export interface RevisionsParams {
712
- /** @default 100 */
713
- first: number;
714
- after?: string;
715
- before?: string;
716
- inclusive?: boolean;
717
- /** Sort order: asc (default) or desc */
718
- sort?: "asc" | "desc";
719
- organizationId: string;
720
- projectName: string;
721
- branchName: string;
722
- }
723
-
724
- export interface TablesParams {
725
- /** @default 100 */
726
- first: number;
727
- after?: string;
728
- revisionId: string;
729
- }
730
-
731
- export interface TableForeignKeysByParams {
732
- /** @default 100 */
733
- first: number;
734
- after?: string;
735
- revisionId: string;
736
- tableId: string;
737
- }
738
-
739
- export interface TableForeignKeysToParams {
740
- /** @default 100 */
741
- first: number;
742
- after?: string;
743
- revisionId: string;
744
- tableId: string;
745
- }
746
-
747
- export interface RowForeignKeysByParams {
748
- foreignKeyByTableId: string;
749
- /** @default 100 */
750
- first: number;
751
- after?: string;
752
- revisionId: string;
753
- tableId: string;
754
- rowId: string;
755
- }
756
-
757
- export interface RowForeignKeysToParams {
758
- foreignKeyToTableId: string;
759
- /** @default 100 */
760
- first: number;
761
- after?: string;
762
- revisionId: string;
763
- tableId: string;
764
- rowId: string;
765
- }
766
-
767
- export type QueryParamsType = Record<string | number, any>;
768
- export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
769
-
770
- export interface FullRequestParams extends Omit<RequestInit, "body"> {
771
- /** set parameter to `true` for call `securityWorker` for this request */
772
- secure?: boolean;
773
- /** request path */
774
- path: string;
775
- /** content type of request body */
776
- type?: ContentType;
777
- /** query params */
778
- query?: QueryParamsType;
779
- /** format of response (i.e. response.json() -> format: "json") */
780
- format?: ResponseFormat;
781
- /** request body */
782
- body?: unknown;
783
- /** base url */
784
- baseUrl?: string;
785
- /** request cancellation token */
786
- cancelToken?: CancelToken;
787
- }
788
-
789
- export type RequestParams = Omit<
790
- FullRequestParams,
791
- "body" | "method" | "query" | "path"
792
- >;
793
-
794
- export interface ApiConfig<SecurityDataType = unknown> {
795
- baseUrl?: string;
796
- baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
797
- securityWorker?: (
798
- securityData: SecurityDataType | null,
799
- ) => Promise<RequestParams | void> | RequestParams | void;
800
- customFetch?: typeof fetch;
801
- }
802
-
803
- export interface HttpResponse<D extends unknown, E extends unknown = unknown>
804
- extends Response {
805
- data: D;
806
- error: E;
807
- }
808
-
809
- type CancelToken = Symbol | string | number;
810
-
811
- export enum ContentType {
812
- Json = "application/json",
813
- JsonApi = "application/vnd.api+json",
814
- FormData = "multipart/form-data",
815
- UrlEncoded = "application/x-www-form-urlencoded",
816
- Text = "text/plain",
817
- }
818
-
819
- export class HttpClient<SecurityDataType = unknown> {
820
- public baseUrl: string = "";
821
- private securityData: SecurityDataType | null = null;
822
- private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
823
- private abortControllers = new Map<CancelToken, AbortController>();
824
- private customFetch = (...fetchParams: Parameters<typeof fetch>) =>
825
- fetch(...fetchParams);
826
-
827
- private baseApiParams: RequestParams = {
828
- credentials: "same-origin",
829
- headers: {},
830
- redirect: "follow",
831
- referrerPolicy: "no-referrer",
832
- };
833
-
834
- constructor(apiConfig: ApiConfig<SecurityDataType> = {}) {
835
- Object.assign(this, apiConfig);
836
- }
837
-
838
- public setSecurityData = (data: SecurityDataType | null) => {
839
- this.securityData = data;
840
- };
841
-
842
- protected encodeQueryParam(key: string, value: any) {
843
- const encodedKey = encodeURIComponent(key);
844
- return `${encodedKey}=${encodeURIComponent(typeof value === "number" ? value : `${value}`)}`;
845
- }
846
-
847
- protected addQueryParam(query: QueryParamsType, key: string) {
848
- return this.encodeQueryParam(key, query[key]);
849
- }
850
-
851
- protected addArrayQueryParam(query: QueryParamsType, key: string) {
852
- const value = query[key];
853
- return value.map((v: any) => this.encodeQueryParam(key, v)).join("&");
854
- }
855
-
856
- protected toQueryString(rawQuery?: QueryParamsType): string {
857
- const query = rawQuery || {};
858
- const keys = Object.keys(query).filter(
859
- (key) => "undefined" !== typeof query[key],
860
- );
861
- return keys
862
- .map((key) =>
863
- Array.isArray(query[key])
864
- ? this.addArrayQueryParam(query, key)
865
- : this.addQueryParam(query, key),
866
- )
867
- .join("&");
868
- }
869
-
870
- protected addQueryParams(rawQuery?: QueryParamsType): string {
871
- const queryString = this.toQueryString(rawQuery);
872
- return queryString ? `?${queryString}` : "";
873
- }
874
-
875
- private contentFormatters: Record<ContentType, (input: any) => any> = {
876
- [ContentType.Json]: (input: any) =>
877
- input !== null && (typeof input === "object" || typeof input === "string")
878
- ? JSON.stringify(input)
879
- : input,
880
- [ContentType.JsonApi]: (input: any) =>
881
- input !== null && (typeof input === "object" || typeof input === "string")
882
- ? JSON.stringify(input)
883
- : input,
884
- [ContentType.Text]: (input: any) =>
885
- input !== null && typeof input !== "string"
886
- ? JSON.stringify(input)
887
- : input,
888
- [ContentType.FormData]: (input: any) =>
889
- Object.keys(input || {}).reduce((formData, key) => {
890
- const property = input[key];
891
- formData.append(
892
- key,
893
- property instanceof Blob
894
- ? property
895
- : typeof property === "object" && property !== null
896
- ? JSON.stringify(property)
897
- : `${property}`,
898
- );
899
- return formData;
900
- }, new FormData()),
901
- [ContentType.UrlEncoded]: (input: any) => this.toQueryString(input),
902
- };
903
-
904
- protected mergeRequestParams(
905
- params1: RequestParams,
906
- params2?: RequestParams,
907
- ): RequestParams {
908
- return {
909
- ...this.baseApiParams,
910
- ...params1,
911
- ...(params2 || {}),
912
- headers: {
913
- ...(this.baseApiParams.headers || {}),
914
- ...(params1.headers || {}),
915
- ...((params2 && params2.headers) || {}),
916
- },
917
- };
918
- }
919
-
920
- protected createAbortSignal = (
921
- cancelToken: CancelToken,
922
- ): AbortSignal | undefined => {
923
- if (this.abortControllers.has(cancelToken)) {
924
- const abortController = this.abortControllers.get(cancelToken);
925
- if (abortController) {
926
- return abortController.signal;
927
- }
928
- return void 0;
929
- }
930
-
931
- const abortController = new AbortController();
932
- this.abortControllers.set(cancelToken, abortController);
933
- return abortController.signal;
934
- };
935
-
936
- public abortRequest = (cancelToken: CancelToken) => {
937
- const abortController = this.abortControllers.get(cancelToken);
938
-
939
- if (abortController) {
940
- abortController.abort();
941
- this.abortControllers.delete(cancelToken);
942
- }
943
- };
944
-
945
- public request = async <T = any, E = any>({
946
- body,
947
- secure,
948
- path,
949
- type,
950
- query,
951
- format,
952
- baseUrl,
953
- cancelToken,
954
- ...params
955
- }: FullRequestParams): Promise<HttpResponse<T, E>> => {
956
- const secureParams =
957
- ((typeof secure === "boolean" ? secure : this.baseApiParams.secure) &&
958
- this.securityWorker &&
959
- (await this.securityWorker(this.securityData))) ||
960
- {};
961
- const requestParams = this.mergeRequestParams(params, secureParams);
962
- const queryString = query && this.toQueryString(query);
963
- const payloadFormatter = this.contentFormatters[type || ContentType.Json];
964
- const responseFormat = format || requestParams.format;
965
-
966
- return this.customFetch(
967
- `${baseUrl || this.baseUrl || ""}${path}${queryString ? `?${queryString}` : ""}`,
968
- {
969
- ...requestParams,
970
- headers: {
971
- ...(requestParams.headers || {}),
972
- ...(type && type !== ContentType.FormData
973
- ? { "Content-Type": type }
974
- : {}),
975
- },
976
- signal:
977
- (cancelToken
978
- ? this.createAbortSignal(cancelToken)
979
- : requestParams.signal) || null,
980
- body:
981
- typeof body === "undefined" || body === null
982
- ? null
983
- : payloadFormatter(body),
984
- },
985
- ).then(async (response) => {
986
- const r = response.clone() as HttpResponse<T, E>;
987
- r.data = null as unknown as T;
988
- r.error = null as unknown as E;
989
-
990
- const data = !responseFormat
991
- ? r
992
- : await response[responseFormat]()
993
- .then((data) => {
994
- if (r.ok) {
995
- r.data = data;
996
- } else {
997
- r.error = data;
998
- }
999
- return r;
1000
- })
1001
- .catch((e) => {
1002
- r.error = e;
1003
- return r;
1004
- });
1005
-
1006
- if (cancelToken) {
1007
- this.abortControllers.delete(cancelToken);
1008
- }
1009
-
1010
- return data;
1011
- });
1012
- };
1013
- }
1014
-
1015
- /**
1016
- * @title Revisium API
1017
- * @version 2.6.0-alpha.3
1018
- * @contact
1019
- */
1020
- export class Api<
1021
- SecurityDataType extends unknown,
1022
- > extends HttpClient<SecurityDataType> {
1023
- api = {
1024
- /**
1025
- * No description
1026
- *
1027
- * @tags Auth
1028
- * @name Login
1029
- * @request POST:/api/auth/login
1030
- * @secure
1031
- */
1032
- login: (data: LoginDto, params: RequestParams = {}) =>
1033
- this.request<LoginResponse, any>({
1034
- path: `/api/auth/login`,
1035
- method: "POST",
1036
- body: data,
1037
- secure: true,
1038
- type: ContentType.Json,
1039
- format: "json",
1040
- ...params,
1041
- }),
1042
-
1043
- /**
1044
- * No description
1045
- *
1046
- * @tags Auth
1047
- * @name CreateUser
1048
- * @request POST:/api/auth/user
1049
- * @secure
1050
- */
1051
- createUser: (data: CreateUserDto, params: RequestParams = {}) =>
1052
- this.request<boolean, any>({
1053
- path: `/api/auth/user`,
1054
- method: "POST",
1055
- body: data,
1056
- secure: true,
1057
- type: ContentType.Json,
1058
- format: "json",
1059
- ...params,
1060
- }),
1061
-
1062
- /**
1063
- * No description
1064
- *
1065
- * @tags Auth
1066
- * @name UpdatePassword
1067
- * @request PUT:/api/auth/password
1068
- * @secure
1069
- */
1070
- updatePassword: (data: UpdatePasswordDto, params: RequestParams = {}) =>
1071
- this.request<boolean, any>({
1072
- path: `/api/auth/password`,
1073
- method: "PUT",
1074
- body: data,
1075
- secure: true,
1076
- type: ContentType.Json,
1077
- format: "json",
1078
- ...params,
1079
- }),
1080
-
1081
- /**
1082
- * No description
1083
- *
1084
- * @tags User
1085
- * @name Me
1086
- * @request GET:/api/user/me
1087
- * @secure
1088
- */
1089
- me: (params: RequestParams = {}) =>
1090
- this.request<UserModel, any>({
1091
- path: `/api/user/me`,
1092
- method: "GET",
1093
- secure: true,
1094
- format: "json",
1095
- ...params,
1096
- }),
1097
-
1098
- /**
1099
- * No description
1100
- *
1101
- * @tags Organization
1102
- * @name Projects
1103
- * @request GET:/api/organization/{organizationId}/projects
1104
- * @secure
1105
- */
1106
- projects: (
1107
- { organizationId, ...query }: ProjectsParams,
1108
- params: RequestParams = {},
1109
- ) =>
1110
- this.request<ProjectsConnection, any>({
1111
- path: `/api/organization/${organizationId}/projects`,
1112
- method: "GET",
1113
- query: query,
1114
- secure: true,
1115
- format: "json",
1116
- ...params,
1117
- }),
1118
-
1119
- /**
1120
- * No description
1121
- *
1122
- * @tags Organization
1123
- * @name CreateProject
1124
- * @request POST:/api/organization/{organizationId}/projects
1125
- * @secure
1126
- */
1127
- createProject: (
1128
- { organizationId, ...query }: CreateProjectParams,
1129
- data: CreateProjectDto,
1130
- params: RequestParams = {},
1131
- ) =>
1132
- this.request<ProjectModel, any>({
1133
- path: `/api/organization/${organizationId}/projects`,
1134
- method: "POST",
1135
- query: query,
1136
- body: data,
1137
- secure: true,
1138
- type: ContentType.Json,
1139
- format: "json",
1140
- ...params,
1141
- }),
1142
-
1143
- /**
1144
- * No description
1145
- *
1146
- * @tags Organization
1147
- * @name UsersOrganization
1148
- * @request GET:/api/organization/{organizationId}/users
1149
- * @secure
1150
- */
1151
- usersOrganization: (
1152
- { organizationId, ...query }: UsersOrganizationParams,
1153
- params: RequestParams = {},
1154
- ) =>
1155
- this.request<UsersOrganizationConnection, any>({
1156
- path: `/api/organization/${organizationId}/users`,
1157
- method: "GET",
1158
- query: query,
1159
- secure: true,
1160
- format: "json",
1161
- ...params,
1162
- }),
1163
-
1164
- /**
1165
- * No description
1166
- *
1167
- * @tags Organization
1168
- * @name AddUserToOrganization
1169
- * @request POST:/api/organization/{organizationId}/users
1170
- * @secure
1171
- */
1172
- addUserToOrganization: (
1173
- organizationId: string,
1174
- data: AddUserToOrganizationDto,
1175
- params: RequestParams = {},
1176
- ) =>
1177
- this.request<boolean, any>({
1178
- path: `/api/organization/${organizationId}/users`,
1179
- method: "POST",
1180
- body: data,
1181
- secure: true,
1182
- type: ContentType.Json,
1183
- format: "json",
1184
- ...params,
1185
- }),
1186
-
1187
- /**
1188
- * No description
1189
- *
1190
- * @tags Organization
1191
- * @name RemoveUserFromOrganization
1192
- * @request DELETE:/api/organization/{organizationId}/users
1193
- * @secure
1194
- */
1195
- removeUserFromOrganization: (
1196
- organizationId: string,
1197
- data: RemoveUserFromOrganizationDto,
1198
- params: RequestParams = {},
1199
- ) =>
1200
- this.request<boolean, any>({
1201
- path: `/api/organization/${organizationId}/users`,
1202
- method: "DELETE",
1203
- body: data,
1204
- secure: true,
1205
- type: ContentType.Json,
1206
- format: "json",
1207
- ...params,
1208
- }),
1209
-
1210
- /**
1211
- * No description
1212
- *
1213
- * @tags Project
1214
- * @name Project
1215
- * @request GET:/api/organization/{organizationId}/projects/{projectName}
1216
- * @secure
1217
- */
1218
- project: (
1219
- organizationId: string,
1220
- projectName: string,
1221
- params: RequestParams = {},
1222
- ) =>
1223
- this.request<ProjectModel, any>({
1224
- path: `/api/organization/${organizationId}/projects/${projectName}`,
1225
- method: "GET",
1226
- secure: true,
1227
- format: "json",
1228
- ...params,
1229
- }),
1230
-
1231
- /**
1232
- * No description
1233
- *
1234
- * @tags Project
1235
- * @name DeleteProject
1236
- * @request DELETE:/api/organization/{organizationId}/projects/{projectName}
1237
- * @secure
1238
- */
1239
- deleteProject: (
1240
- organizationId: string,
1241
- projectName: string,
1242
- params: RequestParams = {},
1243
- ) =>
1244
- this.request<SuccessModelDto, any>({
1245
- path: `/api/organization/${organizationId}/projects/${projectName}`,
1246
- method: "DELETE",
1247
- secure: true,
1248
- format: "json",
1249
- ...params,
1250
- }),
1251
-
1252
- /**
1253
- * No description
1254
- *
1255
- * @tags Project
1256
- * @name UpdateProject
1257
- * @request PUT:/api/organization/{organizationId}/projects/{projectName}
1258
- * @secure
1259
- */
1260
- updateProject: (
1261
- organizationId: string,
1262
- projectName: string,
1263
- data: UpdateProjectDto,
1264
- params: RequestParams = {},
1265
- ) =>
1266
- this.request<SuccessModelDto, any>({
1267
- path: `/api/organization/${organizationId}/projects/${projectName}`,
1268
- method: "PUT",
1269
- body: data,
1270
- secure: true,
1271
- type: ContentType.Json,
1272
- format: "json",
1273
- ...params,
1274
- }),
1275
-
1276
- /**
1277
- * No description
1278
- *
1279
- * @tags Project
1280
- * @name RootBranch
1281
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/root-branch
1282
- * @secure
1283
- */
1284
- rootBranch: (
1285
- organizationId: string,
1286
- projectName: string,
1287
- params: RequestParams = {},
1288
- ) =>
1289
- this.request<BranchModel, any>({
1290
- path: `/api/organization/${organizationId}/projects/${projectName}/root-branch`,
1291
- method: "GET",
1292
- secure: true,
1293
- format: "json",
1294
- ...params,
1295
- }),
1296
-
1297
- /**
1298
- * No description
1299
- *
1300
- * @tags Project
1301
- * @name Branches
1302
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches
1303
- * @secure
1304
- */
1305
- branches: (
1306
- { organizationId, projectName, ...query }: BranchesParams,
1307
- params: RequestParams = {},
1308
- ) =>
1309
- this.request<BranchesConnection, any>({
1310
- path: `/api/organization/${organizationId}/projects/${projectName}/branches`,
1311
- method: "GET",
1312
- query: query,
1313
- secure: true,
1314
- format: "json",
1315
- ...params,
1316
- }),
1317
-
1318
- /**
1319
- * No description
1320
- *
1321
- * @tags Project
1322
- * @name UsersProject
1323
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/users
1324
- * @secure
1325
- */
1326
- usersProject: (
1327
- { organizationId, projectName, ...query }: UsersProjectParams,
1328
- params: RequestParams = {},
1329
- ) =>
1330
- this.request<UsersProjectConnection, any>({
1331
- path: `/api/organization/${organizationId}/projects/${projectName}/users`,
1332
- method: "GET",
1333
- query: query,
1334
- secure: true,
1335
- format: "json",
1336
- ...params,
1337
- }),
1338
-
1339
- /**
1340
- * No description
1341
- *
1342
- * @tags Project
1343
- * @name AddUserToProject
1344
- * @request POST:/api/organization/{organizationId}/projects/{projectName}/users
1345
- * @secure
1346
- */
1347
- addUserToProject: (
1348
- organizationId: string,
1349
- projectName: string,
1350
- data: AddUserToProjectDto,
1351
- params: RequestParams = {},
1352
- ) =>
1353
- this.request<SuccessModelDto, any>({
1354
- path: `/api/organization/${organizationId}/projects/${projectName}/users`,
1355
- method: "POST",
1356
- body: data,
1357
- secure: true,
1358
- type: ContentType.Json,
1359
- format: "json",
1360
- ...params,
1361
- }),
1362
-
1363
- /**
1364
- * No description
1365
- *
1366
- * @tags Project
1367
- * @name RemoveUserFromProject
1368
- * @request DELETE:/api/organization/{organizationId}/projects/{projectName}/users/{userId}
1369
- * @secure
1370
- */
1371
- removeUserFromProject: (
1372
- organizationId: string,
1373
- projectName: string,
1374
- userId: string,
1375
- params: RequestParams = {},
1376
- ) =>
1377
- this.request<SuccessModelDto, any>({
1378
- path: `/api/organization/${organizationId}/projects/${projectName}/users/${userId}`,
1379
- method: "DELETE",
1380
- secure: true,
1381
- format: "json",
1382
- ...params,
1383
- }),
1384
-
1385
- /**
1386
- * No description
1387
- *
1388
- * @tags Branch
1389
- * @name Branch
1390
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}
1391
- * @secure
1392
- */
1393
- branch: (
1394
- organizationId: string,
1395
- projectName: string,
1396
- branchName: string,
1397
- params: RequestParams = {},
1398
- ) =>
1399
- this.request<BranchModel, any>({
1400
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}`,
1401
- method: "GET",
1402
- secure: true,
1403
- format: "json",
1404
- ...params,
1405
- }),
1406
-
1407
- /**
1408
- * No description
1409
- *
1410
- * @tags Branch
1411
- * @name BranchTouched
1412
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/touched
1413
- * @secure
1414
- */
1415
- branchTouched: (
1416
- organizationId: string,
1417
- projectName: string,
1418
- branchName: string,
1419
- params: RequestParams = {},
1420
- ) =>
1421
- this.request<TouchedModelDto, any>({
1422
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/touched`,
1423
- method: "GET",
1424
- secure: true,
1425
- format: "json",
1426
- ...params,
1427
- }),
1428
-
1429
- /**
1430
- * No description
1431
- *
1432
- * @tags Branch
1433
- * @name ParentBranch
1434
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/parent-branch
1435
- * @secure
1436
- */
1437
- parentBranch: (
1438
- organizationId: string,
1439
- projectName: string,
1440
- branchName: string,
1441
- params: RequestParams = {},
1442
- ) =>
1443
- this.request<ParentBranchResponse, any>({
1444
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/parent-branch`,
1445
- method: "GET",
1446
- secure: true,
1447
- format: "json",
1448
- ...params,
1449
- }),
1450
-
1451
- /**
1452
- * No description
1453
- *
1454
- * @tags Branch
1455
- * @name StartRevision
1456
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/start-revision
1457
- * @secure
1458
- */
1459
- startRevision: (
1460
- organizationId: string,
1461
- projectName: string,
1462
- branchName: string,
1463
- params: RequestParams = {},
1464
- ) =>
1465
- this.request<RevisionModel, any>({
1466
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/start-revision`,
1467
- method: "GET",
1468
- secure: true,
1469
- format: "json",
1470
- ...params,
1471
- }),
1472
-
1473
- /**
1474
- * No description
1475
- *
1476
- * @tags Branch
1477
- * @name HeadRevision
1478
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/head-revision
1479
- * @secure
1480
- */
1481
- headRevision: (
1482
- organizationId: string,
1483
- projectName: string,
1484
- branchName: string,
1485
- params: RequestParams = {},
1486
- ) =>
1487
- this.request<RevisionModel, any>({
1488
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/head-revision`,
1489
- method: "GET",
1490
- secure: true,
1491
- format: "json",
1492
- ...params,
1493
- }),
1494
-
1495
- /**
1496
- * No description
1497
- *
1498
- * @tags Branch
1499
- * @name DraftRevision
1500
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/draft-revision
1501
- * @secure
1502
- */
1503
- draftRevision: (
1504
- organizationId: string,
1505
- projectName: string,
1506
- branchName: string,
1507
- params: RequestParams = {},
1508
- ) =>
1509
- this.request<RevisionModel, any>({
1510
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/draft-revision`,
1511
- method: "GET",
1512
- secure: true,
1513
- format: "json",
1514
- ...params,
1515
- }),
1516
-
1517
- /**
1518
- * No description
1519
- *
1520
- * @tags Branch
1521
- * @name Revisions
1522
- * @request GET:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/revisions
1523
- * @secure
1524
- */
1525
- revisions: (
1526
- { organizationId, projectName, branchName, ...query }: RevisionsParams,
1527
- params: RequestParams = {},
1528
- ) =>
1529
- this.request<RevisionsConnection, any>({
1530
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/revisions`,
1531
- method: "GET",
1532
- query: query,
1533
- secure: true,
1534
- format: "json",
1535
- ...params,
1536
- }),
1537
-
1538
- /**
1539
- * No description
1540
- *
1541
- * @tags Branch
1542
- * @name CreateRevision
1543
- * @request POST:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/create-revision
1544
- * @secure
1545
- */
1546
- createRevision: (
1547
- organizationId: string,
1548
- projectName: string,
1549
- branchName: string,
1550
- data: CreateRevisionDto,
1551
- params: RequestParams = {},
1552
- ) =>
1553
- this.request<RevisionModel, any>({
1554
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/create-revision`,
1555
- method: "POST",
1556
- body: data,
1557
- secure: true,
1558
- type: ContentType.Json,
1559
- format: "json",
1560
- ...params,
1561
- }),
1562
-
1563
- /**
1564
- * No description
1565
- *
1566
- * @tags Branch
1567
- * @name RevertChanges
1568
- * @request POST:/api/organization/{organizationId}/projects/{projectName}/branches/{branchName}/revert-changes
1569
- * @secure
1570
- */
1571
- revertChanges: (
1572
- organizationId: string,
1573
- projectName: string,
1574
- branchName: string,
1575
- params: RequestParams = {},
1576
- ) =>
1577
- this.request<BranchModel, any>({
1578
- path: `/api/organization/${organizationId}/projects/${projectName}/branches/${branchName}/revert-changes`,
1579
- method: "POST",
1580
- secure: true,
1581
- format: "json",
1582
- ...params,
1583
- }),
1584
-
1585
- /**
1586
- * No description
1587
- *
1588
- * @tags Revision
1589
- * @name Revision
1590
- * @request GET:/api/revision/{revisionId}
1591
- * @secure
1592
- */
1593
- revision: (revisionId: string, params: RequestParams = {}) =>
1594
- this.request<RevisionModel, any>({
1595
- path: `/api/revision/${revisionId}`,
1596
- method: "GET",
1597
- secure: true,
1598
- format: "json",
1599
- ...params,
1600
- }),
1601
-
1602
- /**
1603
- * No description
1604
- *
1605
- * @tags Revision
1606
- * @name ParentRevision
1607
- * @request GET:/api/revision/{revisionId}/parent-revision
1608
- * @secure
1609
- */
1610
- parentRevision: (revisionId: string, params: RequestParams = {}) =>
1611
- this.request<RevisionModel, any>({
1612
- path: `/api/revision/${revisionId}/parent-revision`,
1613
- method: "GET",
1614
- secure: true,
1615
- format: "json",
1616
- ...params,
1617
- }),
1618
-
1619
- /**
1620
- * No description
1621
- *
1622
- * @tags Revision
1623
- * @name ChildRevision
1624
- * @request GET:/api/revision/{revisionId}/child-revision
1625
- * @secure
1626
- */
1627
- childRevision: (revisionId: string, params: RequestParams = {}) =>
1628
- this.request<RevisionModel, any>({
1629
- path: `/api/revision/${revisionId}/child-revision`,
1630
- method: "GET",
1631
- secure: true,
1632
- format: "json",
1633
- ...params,
1634
- }),
1635
-
1636
- /**
1637
- * No description
1638
- *
1639
- * @tags Revision
1640
- * @name ChildBranches
1641
- * @request GET:/api/revision/{revisionId}/child-branches
1642
- * @secure
1643
- */
1644
- childBranches: (revisionId: string, params: RequestParams = {}) =>
1645
- this.request<ChildBranchResponse[], any>({
1646
- path: `/api/revision/${revisionId}/child-branches`,
1647
- method: "GET",
1648
- secure: true,
1649
- format: "json",
1650
- ...params,
1651
- }),
1652
-
1653
- /**
1654
- * No description
1655
- *
1656
- * @tags Revision
1657
- * @name CreateBranch
1658
- * @request POST:/api/revision/{revisionId}/child-branches
1659
- * @secure
1660
- */
1661
- createBranch: (
1662
- revisionId: string,
1663
- data: CreateBranchByRevisionDto,
1664
- params: RequestParams = {},
1665
- ) =>
1666
- this.request<BranchModel, any>({
1667
- path: `/api/revision/${revisionId}/child-branches`,
1668
- method: "POST",
1669
- body: data,
1670
- secure: true,
1671
- type: ContentType.Json,
1672
- format: "json",
1673
- ...params,
1674
- }),
1675
-
1676
- /**
1677
- * No description
1678
- *
1679
- * @tags Revision
1680
- * @name Tables
1681
- * @request GET:/api/revision/{revisionId}/tables
1682
- * @secure
1683
- */
1684
- tables: (
1685
- { revisionId, ...query }: TablesParams,
1686
- params: RequestParams = {},
1687
- ) =>
1688
- this.request<TablesConnection, any>({
1689
- path: `/api/revision/${revisionId}/tables`,
1690
- method: "GET",
1691
- query: query,
1692
- secure: true,
1693
- format: "json",
1694
- ...params,
1695
- }),
1696
-
1697
- /**
1698
- * No description
1699
- *
1700
- * @tags Revision
1701
- * @name CreateTable
1702
- * @request POST:/api/revision/{revisionId}/tables
1703
- * @secure
1704
- */
1705
- createTable: (
1706
- revisionId: string,
1707
- data: CreateTableDto,
1708
- params: RequestParams = {},
1709
- ) =>
1710
- this.request<CreateTableResponse, any>({
1711
- path: `/api/revision/${revisionId}/tables`,
1712
- method: "POST",
1713
- body: data,
1714
- secure: true,
1715
- type: ContentType.Json,
1716
- format: "json",
1717
- ...params,
1718
- }),
1719
-
1720
- /**
1721
- * No description
1722
- *
1723
- * @tags Revision
1724
- * @name Endpoints
1725
- * @request GET:/api/revision/{revisionId}/endpoints
1726
- * @secure
1727
- */
1728
- endpoints: (revisionId: string, params: RequestParams = {}) =>
1729
- this.request<EndpointModel[], any>({
1730
- path: `/api/revision/${revisionId}/endpoints`,
1731
- method: "GET",
1732
- secure: true,
1733
- format: "json",
1734
- ...params,
1735
- }),
1736
-
1737
- /**
1738
- * No description
1739
- *
1740
- * @tags Revision
1741
- * @name CreateEndpoint
1742
- * @request POST:/api/revision/{revisionId}/endpoints
1743
- * @secure
1744
- */
1745
- createEndpoint: (
1746
- revisionId: string,
1747
- data: CreateEndpointDto,
1748
- params: RequestParams = {},
1749
- ) =>
1750
- this.request<EndpointModel, any>({
1751
- path: `/api/revision/${revisionId}/endpoints`,
1752
- method: "POST",
1753
- body: data,
1754
- secure: true,
1755
- type: ContentType.Json,
1756
- format: "json",
1757
- ...params,
1758
- }),
1759
-
1760
- /**
1761
- * No description
1762
- *
1763
- * @tags Revision
1764
- * @name Migrations
1765
- * @request GET:/api/revision/{revisionId}/migrations
1766
- * @secure
1767
- */
1768
- migrations: (revisionId: string, params: RequestParams = {}) =>
1769
- this.request<
1770
- (
1771
- | InitMigrationDto
1772
- | UpdateMigrationDto
1773
- | RenameMigrationDto
1774
- | RemoveMigrationDto
1775
- )[],
1776
- any
1777
- >({
1778
- path: `/api/revision/${revisionId}/migrations`,
1779
- method: "GET",
1780
- secure: true,
1781
- format: "json",
1782
- ...params,
1783
- }),
1784
-
1785
- /**
1786
- * No description
1787
- *
1788
- * @tags Revision
1789
- * @name ApplyMigrations
1790
- * @request POST:/api/revision/{revisionId}/apply-migrations
1791
- * @secure
1792
- */
1793
- applyMigrations: (
1794
- revisionId: string,
1795
- data: (
1796
- | InitMigrationDto
1797
- | UpdateMigrationDto
1798
- | RenameMigrationDto
1799
- | RemoveMigrationDto
1800
- )[],
1801
- params: RequestParams = {},
1802
- ) =>
1803
- this.request<ApplyMigrationsResponseDto[], any>({
1804
- path: `/api/revision/${revisionId}/apply-migrations`,
1805
- method: "POST",
1806
- body: data,
1807
- secure: true,
1808
- type: ContentType.Json,
1809
- format: "json",
1810
- ...params,
1811
- }),
1812
-
1813
- /**
1814
- * No description
1815
- *
1816
- * @tags Table
1817
- * @name Table
1818
- * @request GET:/api/revision/{revisionId}/tables/{tableId}
1819
- * @secure
1820
- */
1821
- table: (revisionId: string, tableId: string, params: RequestParams = {}) =>
1822
- this.request<TableModel, any>({
1823
- path: `/api/revision/${revisionId}/tables/${tableId}`,
1824
- method: "GET",
1825
- secure: true,
1826
- format: "json",
1827
- ...params,
1828
- }),
1829
-
1830
- /**
1831
- * No description
1832
- *
1833
- * @tags Table
1834
- * @name DeleteTable
1835
- * @request DELETE:/api/revision/{revisionId}/tables/{tableId}
1836
- * @secure
1837
- */
1838
- deleteTable: (
1839
- revisionId: string,
1840
- tableId: string,
1841
- params: RequestParams = {},
1842
- ) =>
1843
- this.request<BranchModel, any>({
1844
- path: `/api/revision/${revisionId}/tables/${tableId}`,
1845
- method: "DELETE",
1846
- secure: true,
1847
- format: "json",
1848
- ...params,
1849
- }),
1850
-
1851
- /**
1852
- * No description
1853
- *
1854
- * @tags Table
1855
- * @name UpdateTable
1856
- * @request PATCH:/api/revision/{revisionId}/tables/{tableId}
1857
- * @secure
1858
- */
1859
- updateTable: (
1860
- revisionId: string,
1861
- tableId: string,
1862
- data: UpdateTableDto,
1863
- params: RequestParams = {},
1864
- ) =>
1865
- this.request<UpdateTableResponse, any>({
1866
- path: `/api/revision/${revisionId}/tables/${tableId}`,
1867
- method: "PATCH",
1868
- body: data,
1869
- secure: true,
1870
- type: ContentType.Json,
1871
- format: "json",
1872
- ...params,
1873
- }),
1874
-
1875
- /**
1876
- * No description
1877
- *
1878
- * @tags Table
1879
- * @name TableCountRows
1880
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/count-rows
1881
- * @secure
1882
- */
1883
- tableCountRows: (
1884
- revisionId: string,
1885
- tableId: string,
1886
- params: RequestParams = {},
1887
- ) =>
1888
- this.request<number, any>({
1889
- path: `/api/revision/${revisionId}/tables/${tableId}/count-rows`,
1890
- method: "GET",
1891
- secure: true,
1892
- format: "json",
1893
- ...params,
1894
- }),
1895
-
1896
- /**
1897
- * No description
1898
- *
1899
- * @tags Table
1900
- * @name Rows
1901
- * @request POST:/api/revision/{revisionId}/tables/{tableId}/rows
1902
- * @secure
1903
- */
1904
- rows: (
1905
- revisionId: string,
1906
- tableId: string,
1907
- data: GetTableRowsDto,
1908
- params: RequestParams = {},
1909
- ) =>
1910
- this.request<RowsConnection, any>({
1911
- path: `/api/revision/${revisionId}/tables/${tableId}/rows`,
1912
- method: "POST",
1913
- body: data,
1914
- secure: true,
1915
- type: ContentType.Json,
1916
- format: "json",
1917
- ...params,
1918
- }),
1919
-
1920
- /**
1921
- * No description
1922
- *
1923
- * @tags Table
1924
- * @name DeleteRows
1925
- * @request DELETE:/api/revision/{revisionId}/tables/{tableId}/rows
1926
- * @secure
1927
- */
1928
- deleteRows: (
1929
- revisionId: string,
1930
- tableId: string,
1931
- data: RemoveRowsDto,
1932
- params: RequestParams = {},
1933
- ) =>
1934
- this.request<RemoveRowsResponse, any>({
1935
- path: `/api/revision/${revisionId}/tables/${tableId}/rows`,
1936
- method: "DELETE",
1937
- body: data,
1938
- secure: true,
1939
- type: ContentType.Json,
1940
- format: "json",
1941
- ...params,
1942
- }),
1943
-
1944
- /**
1945
- * No description
1946
- *
1947
- * @tags Table
1948
- * @name CreateRow
1949
- * @request POST:/api/revision/{revisionId}/tables/{tableId}/create-row
1950
- * @secure
1951
- */
1952
- createRow: (
1953
- revisionId: string,
1954
- tableId: string,
1955
- data: CreateRowDto,
1956
- params: RequestParams = {},
1957
- ) =>
1958
- this.request<CreateRowResponse, any>({
1959
- path: `/api/revision/${revisionId}/tables/${tableId}/create-row`,
1960
- method: "POST",
1961
- body: data,
1962
- secure: true,
1963
- type: ContentType.Json,
1964
- format: "json",
1965
- ...params,
1966
- }),
1967
-
1968
- /**
1969
- * No description
1970
- *
1971
- * @tags Table
1972
- * @name CreateRows
1973
- * @request POST:/api/revision/{revisionId}/tables/{tableId}/create-rows
1974
- * @secure
1975
- */
1976
- createRows: (
1977
- revisionId: string,
1978
- tableId: string,
1979
- data: CreateRowsDto,
1980
- params: RequestParams = {},
1981
- ) =>
1982
- this.request<CreateRowsResponse, any>({
1983
- path: `/api/revision/${revisionId}/tables/${tableId}/create-rows`,
1984
- method: "POST",
1985
- body: data,
1986
- secure: true,
1987
- type: ContentType.Json,
1988
- format: "json",
1989
- ...params,
1990
- }),
1991
-
1992
- /**
1993
- * No description
1994
- *
1995
- * @tags Table
1996
- * @name UpdateRows
1997
- * @request PUT:/api/revision/{revisionId}/tables/{tableId}/update-rows
1998
- * @secure
1999
- */
2000
- updateRows: (
2001
- revisionId: string,
2002
- tableId: string,
2003
- data: UpdateRowsDto,
2004
- params: RequestParams = {},
2005
- ) =>
2006
- this.request<UpdateRowsResponse, any>({
2007
- path: `/api/revision/${revisionId}/tables/${tableId}/update-rows`,
2008
- method: "PUT",
2009
- body: data,
2010
- secure: true,
2011
- type: ContentType.Json,
2012
- format: "json",
2013
- ...params,
2014
- }),
2015
-
2016
- /**
2017
- * No description
2018
- *
2019
- * @tags Table
2020
- * @name PatchRows
2021
- * @request PATCH:/api/revision/{revisionId}/tables/{tableId}/patch-rows
2022
- * @secure
2023
- */
2024
- patchRows: (
2025
- revisionId: string,
2026
- tableId: string,
2027
- data: PatchRowsDto,
2028
- params: RequestParams = {},
2029
- ) =>
2030
- this.request<PatchRowsResponse, any>({
2031
- path: `/api/revision/${revisionId}/tables/${tableId}/patch-rows`,
2032
- method: "PATCH",
2033
- body: data,
2034
- secure: true,
2035
- type: ContentType.Json,
2036
- format: "json",
2037
- ...params,
2038
- }),
2039
-
2040
- /**
2041
- * No description
2042
- *
2043
- * @tags Table
2044
- * @name TableSchema
2045
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/schema
2046
- * @secure
2047
- */
2048
- tableSchema: (
2049
- revisionId: string,
2050
- tableId: string,
2051
- params: RequestParams = {},
2052
- ) =>
2053
- this.request<object, any>({
2054
- path: `/api/revision/${revisionId}/tables/${tableId}/schema`,
2055
- method: "GET",
2056
- secure: true,
2057
- format: "json",
2058
- ...params,
2059
- }),
2060
-
2061
- /**
2062
- * No description
2063
- *
2064
- * @tags Table
2065
- * @name TableCountForeignKeysBy
2066
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/count-foreign-keys-by
2067
- * @secure
2068
- */
2069
- tableCountForeignKeysBy: (
2070
- revisionId: string,
2071
- tableId: string,
2072
- params: RequestParams = {},
2073
- ) =>
2074
- this.request<number, any>({
2075
- path: `/api/revision/${revisionId}/tables/${tableId}/count-foreign-keys-by`,
2076
- method: "GET",
2077
- secure: true,
2078
- format: "json",
2079
- ...params,
2080
- }),
2081
-
2082
- /**
2083
- * No description
2084
- *
2085
- * @tags Table
2086
- * @name TableForeignKeysBy
2087
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/foreign-keys-by
2088
- * @secure
2089
- */
2090
- tableForeignKeysBy: (
2091
- { revisionId, tableId, ...query }: TableForeignKeysByParams,
2092
- params: RequestParams = {},
2093
- ) =>
2094
- this.request<TablesConnection, any>({
2095
- path: `/api/revision/${revisionId}/tables/${tableId}/foreign-keys-by`,
2096
- method: "GET",
2097
- query: query,
2098
- secure: true,
2099
- format: "json",
2100
- ...params,
2101
- }),
2102
-
2103
- /**
2104
- * No description
2105
- *
2106
- * @tags Table
2107
- * @name TableCountForeignKeysTo
2108
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/count-foreign-keys-to
2109
- * @secure
2110
- */
2111
- tableCountForeignKeysTo: (
2112
- revisionId: string,
2113
- tableId: string,
2114
- params: RequestParams = {},
2115
- ) =>
2116
- this.request<number, any>({
2117
- path: `/api/revision/${revisionId}/tables/${tableId}/count-foreign-keys-to`,
2118
- method: "GET",
2119
- secure: true,
2120
- format: "json",
2121
- ...params,
2122
- }),
2123
-
2124
- /**
2125
- * No description
2126
- *
2127
- * @tags Table
2128
- * @name TableForeignKeysTo
2129
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/foreign-keys-to
2130
- * @secure
2131
- */
2132
- tableForeignKeysTo: (
2133
- { revisionId, tableId, ...query }: TableForeignKeysToParams,
2134
- params: RequestParams = {},
2135
- ) =>
2136
- this.request<TablesConnection, any>({
2137
- path: `/api/revision/${revisionId}/tables/${tableId}/foreign-keys-to`,
2138
- method: "GET",
2139
- query: query,
2140
- secure: true,
2141
- format: "json",
2142
- ...params,
2143
- }),
2144
-
2145
- /**
2146
- * No description
2147
- *
2148
- * @tags Table
2149
- * @name RenameTable
2150
- * @request PATCH:/api/revision/{revisionId}/tables/{tableId}/rename
2151
- * @secure
2152
- */
2153
- renameTable: (
2154
- revisionId: string,
2155
- tableId: string,
2156
- data: UpdateTableDto,
2157
- params: RequestParams = {},
2158
- ) =>
2159
- this.request<UpdateTableResponse, any>({
2160
- path: `/api/revision/${revisionId}/tables/${tableId}/rename`,
2161
- method: "PATCH",
2162
- body: data,
2163
- secure: true,
2164
- type: ContentType.Json,
2165
- format: "json",
2166
- ...params,
2167
- }),
2168
-
2169
- /**
2170
- * No description
2171
- *
2172
- * @tags Row
2173
- * @name Row
2174
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}
2175
- * @secure
2176
- */
2177
- row: (
2178
- revisionId: string,
2179
- tableId: string,
2180
- rowId: string,
2181
- params: RequestParams = {},
2182
- ) =>
2183
- this.request<RowModel, ErrorModel>({
2184
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}`,
2185
- method: "GET",
2186
- secure: true,
2187
- format: "json",
2188
- ...params,
2189
- }),
2190
-
2191
- /**
2192
- * No description
2193
- *
2194
- * @tags Row
2195
- * @name DeleteRow
2196
- * @request DELETE:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}
2197
- * @secure
2198
- */
2199
- deleteRow: (
2200
- revisionId: string,
2201
- tableId: string,
2202
- rowId: string,
2203
- params: RequestParams = {},
2204
- ) =>
2205
- this.request<RemoveRowResponse, any>({
2206
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}`,
2207
- method: "DELETE",
2208
- secure: true,
2209
- format: "json",
2210
- ...params,
2211
- }),
2212
-
2213
- /**
2214
- * No description
2215
- *
2216
- * @tags Row
2217
- * @name UpdateRow
2218
- * @request PUT:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}
2219
- * @secure
2220
- */
2221
- updateRow: (
2222
- revisionId: string,
2223
- tableId: string,
2224
- rowId: string,
2225
- data: UpdateRowDto,
2226
- params: RequestParams = {},
2227
- ) =>
2228
- this.request<UpdateRowResponse, any>({
2229
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}`,
2230
- method: "PUT",
2231
- body: data,
2232
- secure: true,
2233
- type: ContentType.Json,
2234
- format: "json",
2235
- ...params,
2236
- }),
2237
-
2238
- /**
2239
- * No description
2240
- *
2241
- * @tags Row
2242
- * @name PatchRow
2243
- * @request PATCH:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}
2244
- * @secure
2245
- */
2246
- patchRow: (
2247
- revisionId: string,
2248
- tableId: string,
2249
- rowId: string,
2250
- data: PatchRowDto,
2251
- params: RequestParams = {},
2252
- ) =>
2253
- this.request<PatchRowResponse, any>({
2254
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}`,
2255
- method: "PATCH",
2256
- body: data,
2257
- secure: true,
2258
- type: ContentType.Json,
2259
- format: "json",
2260
- ...params,
2261
- }),
2262
-
2263
- /**
2264
- * No description
2265
- *
2266
- * @tags Row
2267
- * @name RowCountForeignKeysBy
2268
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}/count-foreign-keys-by
2269
- * @secure
2270
- */
2271
- rowCountForeignKeysBy: (
2272
- revisionId: string,
2273
- tableId: string,
2274
- rowId: string,
2275
- params: RequestParams = {},
2276
- ) =>
2277
- this.request<number, any>({
2278
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}/count-foreign-keys-by`,
2279
- method: "GET",
2280
- secure: true,
2281
- format: "json",
2282
- ...params,
2283
- }),
2284
-
2285
- /**
2286
- * No description
2287
- *
2288
- * @tags Row
2289
- * @name RowForeignKeysBy
2290
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}/foreign-keys-by
2291
- * @secure
2292
- */
2293
- rowForeignKeysBy: (
2294
- { revisionId, tableId, rowId, ...query }: RowForeignKeysByParams,
2295
- params: RequestParams = {},
2296
- ) =>
2297
- this.request<RowsConnection, any>({
2298
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}/foreign-keys-by`,
2299
- method: "GET",
2300
- query: query,
2301
- secure: true,
2302
- format: "json",
2303
- ...params,
2304
- }),
2305
-
2306
- /**
2307
- * No description
2308
- *
2309
- * @tags Row
2310
- * @name RowCountForeignKeysTo
2311
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}/count-foreign-keys-to
2312
- * @secure
2313
- */
2314
- rowCountForeignKeysTo: (
2315
- revisionId: string,
2316
- tableId: string,
2317
- rowId: string,
2318
- params: RequestParams = {},
2319
- ) =>
2320
- this.request<number, any>({
2321
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}/count-foreign-keys-to`,
2322
- method: "GET",
2323
- secure: true,
2324
- format: "json",
2325
- ...params,
2326
- }),
2327
-
2328
- /**
2329
- * No description
2330
- *
2331
- * @tags Row
2332
- * @name RowForeignKeysTo
2333
- * @request GET:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}/foreign-keys-to
2334
- * @secure
2335
- */
2336
- rowForeignKeysTo: (
2337
- { revisionId, tableId, rowId, ...query }: RowForeignKeysToParams,
2338
- params: RequestParams = {},
2339
- ) =>
2340
- this.request<RowsConnection, any>({
2341
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}/foreign-keys-to`,
2342
- method: "GET",
2343
- query: query,
2344
- secure: true,
2345
- format: "json",
2346
- ...params,
2347
- }),
2348
-
2349
- /**
2350
- * No description
2351
- *
2352
- * @tags Row
2353
- * @name RenameRow
2354
- * @request PATCH:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}/rename
2355
- * @secure
2356
- */
2357
- renameRow: (
2358
- revisionId: string,
2359
- tableId: string,
2360
- rowId: string,
2361
- data: RenameRowDto,
2362
- params: RequestParams = {},
2363
- ) =>
2364
- this.request<RenameRowResponse, any>({
2365
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}/rename`,
2366
- method: "PATCH",
2367
- body: data,
2368
- secure: true,
2369
- type: ContentType.Json,
2370
- format: "json",
2371
- ...params,
2372
- }),
2373
-
2374
- /**
2375
- * No description
2376
- *
2377
- * @tags Row
2378
- * @name UploadFile
2379
- * @request POST:/api/revision/{revisionId}/tables/{tableId}/rows/{rowId}/upload/{fileId}
2380
- * @secure
2381
- */
2382
- uploadFile: (
2383
- revisionId: string,
2384
- tableId: string,
2385
- rowId: string,
2386
- fileId: string,
2387
- data: {
2388
- /** @format binary */
2389
- file: File;
2390
- },
2391
- params: RequestParams = {},
2392
- ) =>
2393
- this.request<UploadFileResponse, any>({
2394
- path: `/api/revision/${revisionId}/tables/${tableId}/rows/${rowId}/upload/${fileId}`,
2395
- method: "POST",
2396
- body: data,
2397
- secure: true,
2398
- type: ContentType.FormData,
2399
- format: "json",
2400
- ...params,
2401
- }),
2402
-
2403
- /**
2404
- * No description
2405
- *
2406
- * @tags Endpoint
2407
- * @name EndpointRelatives
2408
- * @summary Retrieve all related entities for a given endpoint
2409
- * @request GET:/api/endpoints/{endpointId}/relatives
2410
- * @secure
2411
- */
2412
- endpointRelatives: (endpointId: string, params: RequestParams = {}) =>
2413
- this.request<GetEndpointResultDto, any>({
2414
- path: `/api/endpoints/${endpointId}/relatives`,
2415
- method: "GET",
2416
- secure: true,
2417
- format: "json",
2418
- ...params,
2419
- }),
2420
-
2421
- /**
2422
- * No description
2423
- *
2424
- * @tags Endpoint
2425
- * @name DeleteEndpoint
2426
- * @request DELETE:/api/endpoints/{endpointId}
2427
- * @secure
2428
- */
2429
- deleteEndpoint: (endpointId: string, params: RequestParams = {}) =>
2430
- this.request<boolean, any>({
2431
- path: `/api/endpoints/${endpointId}`,
2432
- method: "DELETE",
2433
- secure: true,
2434
- format: "json",
2435
- ...params,
2436
- }),
2437
-
2438
- /**
2439
- * No description
2440
- *
2441
- * @tags Configuration
2442
- * @name GetConfiguration
2443
- * @request GET:/api/configuration
2444
- */
2445
- getConfiguration: (params: RequestParams = {}) =>
2446
- this.request<ConfigurationResponse, any>({
2447
- path: `/api/configuration`,
2448
- method: "GET",
2449
- format: "json",
2450
- ...params,
2451
- }),
2452
- };
2453
- health = {
2454
- /**
2455
- * No description
2456
- *
2457
- * @tags health
2458
- * @name Readiness
2459
- * @request GET:/health/readiness
2460
- */
2461
- readiness: (params: RequestParams = {}) =>
2462
- this.request<
2463
- {
2464
- /** @example "ok" */
2465
- status?: string;
2466
- /** @example {"database":{"status":"up"}} */
2467
- info?: Record<
2468
- string,
2469
- {
2470
- status: string;
2471
- [key: string]: any;
2472
- }
2473
- >;
2474
- /** @example {} */
2475
- error?: Record<
2476
- string,
2477
- {
2478
- status: string;
2479
- [key: string]: any;
2480
- }
2481
- >;
2482
- /** @example {"database":{"status":"up"}} */
2483
- details?: Record<
2484
- string,
2485
- {
2486
- status: string;
2487
- [key: string]: any;
2488
- }
2489
- >;
2490
- },
2491
- {
2492
- /** @example "error" */
2493
- status?: string;
2494
- /** @example {"database":{"status":"up"}} */
2495
- info?: Record<
2496
- string,
2497
- {
2498
- status: string;
2499
- [key: string]: any;
2500
- }
2501
- >;
2502
- /** @example {"redis":{"status":"down","message":"Could not connect"}} */
2503
- error?: Record<
2504
- string,
2505
- {
2506
- status: string;
2507
- [key: string]: any;
2508
- }
2509
- >;
2510
- /** @example {"database":{"status":"up"},"redis":{"status":"down","message":"Could not connect"}} */
2511
- details?: Record<
2512
- string,
2513
- {
2514
- status: string;
2515
- [key: string]: any;
2516
- }
2517
- >;
2518
- }
2519
- >({
2520
- path: `/health/readiness`,
2521
- method: "GET",
2522
- format: "json",
2523
- ...params,
2524
- }),
2525
-
2526
- /**
2527
- * No description
2528
- *
2529
- * @tags health
2530
- * @name Liveness
2531
- * @request GET:/health/liveness
2532
- */
2533
- liveness: (params: RequestParams = {}) =>
2534
- this.request<
2535
- {
2536
- /** @example "ok" */
2537
- status?: string;
2538
- /** @example {"database":{"status":"up"}} */
2539
- info?: Record<
2540
- string,
2541
- {
2542
- status: string;
2543
- [key: string]: any;
2544
- }
2545
- >;
2546
- /** @example {} */
2547
- error?: Record<
2548
- string,
2549
- {
2550
- status: string;
2551
- [key: string]: any;
2552
- }
2553
- >;
2554
- /** @example {"database":{"status":"up"}} */
2555
- details?: Record<
2556
- string,
2557
- {
2558
- status: string;
2559
- [key: string]: any;
2560
- }
2561
- >;
2562
- },
2563
- {
2564
- /** @example "error" */
2565
- status?: string;
2566
- /** @example {"database":{"status":"up"}} */
2567
- info?: Record<
2568
- string,
2569
- {
2570
- status: string;
2571
- [key: string]: any;
2572
- }
2573
- >;
2574
- /** @example {"redis":{"status":"down","message":"Could not connect"}} */
2575
- error?: Record<
2576
- string,
2577
- {
2578
- status: string;
2579
- [key: string]: any;
2580
- }
2581
- >;
2582
- /** @example {"database":{"status":"up"},"redis":{"status":"down","message":"Could not connect"}} */
2583
- details?: Record<
2584
- string,
2585
- {
2586
- status: string;
2587
- [key: string]: any;
2588
- }
2589
- >;
2590
- }
2591
- >({
2592
- path: `/health/liveness`,
2593
- method: "GET",
2594
- format: "json",
2595
- ...params,
2596
- }),
2597
- };
2598
- }