@permute/sdk 0.2.0 → 0.4.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.
@@ -2,6 +2,104 @@ export type paths = Record<string, never>;
2
2
  export type webhooks = Record<string, never>;
3
3
  export interface components {
4
4
  schemas: {
5
+ ActionCreateRequest: {
6
+ name: string;
7
+ };
8
+ ActionDefinition: {
9
+ draft: {
10
+ definition: {
11
+ connectors?: {
12
+ [key: string]: string;
13
+ };
14
+ inputSchema: {
15
+ [key: string]: unknown;
16
+ };
17
+ /** @enum {string} */
18
+ invokePermission: 'read' | 'write' | 'admin';
19
+ outputSchema: {
20
+ [key: string]: unknown;
21
+ };
22
+ source: string;
23
+ sources: {
24
+ readTables: string[];
25
+ revisionId: string;
26
+ sourceId: string;
27
+ writeTables: string[];
28
+ }[];
29
+ };
30
+ revisionId: string;
31
+ sequence: number;
32
+ } | null;
33
+ published: {
34
+ definition: {
35
+ connectors?: {
36
+ [key: string]: string;
37
+ };
38
+ inputSchema: {
39
+ [key: string]: unknown;
40
+ };
41
+ /** @enum {string} */
42
+ invokePermission: 'read' | 'write' | 'admin';
43
+ outputSchema: {
44
+ [key: string]: unknown;
45
+ };
46
+ source: string;
47
+ sources: {
48
+ readTables: string[];
49
+ revisionId: string;
50
+ sourceId: string;
51
+ writeTables: string[];
52
+ }[];
53
+ };
54
+ revisionId: string;
55
+ sequence: number;
56
+ } | null;
57
+ };
58
+ ActionDefinitionSaved: {
59
+ revisionId: string;
60
+ };
61
+ ActionDefinitionSaveRequest: {
62
+ definition: {
63
+ connectors?: {
64
+ [key: string]: string;
65
+ };
66
+ inputSchema: {
67
+ [key: string]: unknown;
68
+ };
69
+ /** @enum {string} */
70
+ invokePermission: 'read' | 'write' | 'admin';
71
+ outputSchema: {
72
+ [key: string]: unknown;
73
+ };
74
+ source: string;
75
+ sources: {
76
+ readTables: string[];
77
+ revisionId: string;
78
+ sourceId: string;
79
+ writeTables: string[];
80
+ }[];
81
+ };
82
+ expectedDraft: {
83
+ revisionId: string;
84
+ sequence: number;
85
+ } | null;
86
+ };
87
+ ActionIdParams: {
88
+ actionId: string;
89
+ };
90
+ ActionReceipt: {
91
+ actionId: string;
92
+ output?: unknown;
93
+ requestId: string;
94
+ revisionId: string;
95
+ versions: string[];
96
+ };
97
+ ActionRequest: {
98
+ input: {
99
+ [key: string]: unknown;
100
+ };
101
+ requestId: string;
102
+ };
5
103
  AnswerCitation: {
6
104
  metadata?: {
7
105
  [key: string]: unknown;
@@ -103,6 +201,132 @@ export interface components {
103
201
  message: string;
104
202
  requestId?: string;
105
203
  };
204
+ AppCreateRequest: {
205
+ /** @default */
206
+ description: string;
207
+ key?: string;
208
+ name: string;
209
+ };
210
+ AppDeleted: {
211
+ deleted: boolean;
212
+ id: string;
213
+ };
214
+ AppDraft: {
215
+ createdAt: string;
216
+ deployment: {
217
+ error: string | null;
218
+ revisionId: string;
219
+ /** @enum {string} */
220
+ status: 'deploying' | 'live' | 'deleting' | 'failed' | 'deleted';
221
+ /** Format: uri */
222
+ url: string;
223
+ } | null;
224
+ description: string;
225
+ draft: {
226
+ revisionId: string;
227
+ sequence: number;
228
+ };
229
+ id: string;
230
+ name: string;
231
+ updatedAt: string;
232
+ workspaceId: string;
233
+ };
234
+ AppDraftList: {
235
+ items: {
236
+ createdAt: string;
237
+ deployment: {
238
+ error: string | null;
239
+ revisionId: string;
240
+ /** @enum {string} */
241
+ status: 'deploying' | 'live' | 'deleting' | 'failed' | 'deleted';
242
+ /** Format: uri */
243
+ url: string;
244
+ } | null;
245
+ description: string;
246
+ draft: {
247
+ revisionId: string;
248
+ sequence: number;
249
+ };
250
+ id: string;
251
+ name: string;
252
+ updatedAt: string;
253
+ workspaceId: string;
254
+ }[];
255
+ };
256
+ AppIdParams: {
257
+ applicationId: string;
258
+ };
259
+ AppSiteSaveRequest: {
260
+ actions?: {
261
+ actionId: string;
262
+ revisionId: string;
263
+ }[];
264
+ expectedDraft: {
265
+ revisionId: string;
266
+ sequence: number;
267
+ };
268
+ site: {
269
+ files: {
270
+ path: string;
271
+ sha256: string;
272
+ size: number;
273
+ }[];
274
+ spa: boolean;
275
+ };
276
+ sourceIds?: string[];
277
+ };
278
+ AppUpdateRequest: {
279
+ description: string;
280
+ expectedDraft: {
281
+ revisionId: string;
282
+ sequence: number;
283
+ };
284
+ name: string;
285
+ };
286
+ AppUploads: {
287
+ uploads: {
288
+ headers: {
289
+ [key: string]: string;
290
+ };
291
+ path: string;
292
+ /** Format: uri */
293
+ url: string;
294
+ }[];
295
+ };
296
+ AppUploadsRequest: {
297
+ files: {
298
+ path: string;
299
+ sha256: string;
300
+ size: number;
301
+ }[];
302
+ };
303
+ BusinessAction: {
304
+ createdAt: string;
305
+ id: string;
306
+ name: string;
307
+ updatedAt: string;
308
+ workspaceId: string;
309
+ };
310
+ BusinessActionList: {
311
+ items: {
312
+ contract: {
313
+ inputSchema: {
314
+ [key: string]: unknown;
315
+ };
316
+ /** @enum {string} */
317
+ invokePermission: 'read' | 'write' | 'admin';
318
+ outputSchema: {
319
+ [key: string]: unknown;
320
+ };
321
+ } | null;
322
+ createdAt: string;
323
+ id: string;
324
+ name: string;
325
+ revisionId: string | null;
326
+ updatedAt: string;
327
+ workspaceId: string;
328
+ }[];
329
+ };
106
330
  CatalogField: {
107
331
  description?: string | null;
108
332
  isPrimaryKey?: boolean | null;
@@ -124,6 +348,54 @@ export interface components {
124
348
  name: string;
125
349
  provider?: string;
126
350
  };
351
+ /** @enum {string} */
352
+ ConnectorProviderId: 'acumatica' | 'attio' | 'autodesk' | 'bigquery' | 'billcom' | 'brex' | 'double' | 'fireflies' | 'googleads' | 'granola' | 'hubspot' | 'klaviyo' | 'mercury' | 'meta_ads' | 'microsoft_advertising' | 'monday' | 'procore' | 'quickbooks' | 'quo' | 's3' | 'salesforce' | 'shopify' | 'stripe' | 'supabase' | 'tiktok_ads' | 'xero';
353
+ ConnectorSession: {
354
+ connectorId: string;
355
+ connectorStatus: string;
356
+ /** Format: date-time */
357
+ expiresAt: string;
358
+ id: string;
359
+ provider: string;
360
+ /** @enum {string} */
361
+ status: 'pending' | 'in_progress' | 'authorized' | 'completed' | 'expired';
362
+ };
363
+ ConnectorSessionCreated: {
364
+ connectorId: string;
365
+ connectorStatus: string;
366
+ /** Format: date-time */
367
+ expiresAt: string;
368
+ id: string;
369
+ provider: string;
370
+ /** @enum {string} */
371
+ status: 'pending' | 'in_progress' | 'authorized' | 'completed' | 'expired';
372
+ /** Format: uri */
373
+ url: string;
374
+ };
375
+ ConnectorSessionCreateRequest: {
376
+ config?: {
377
+ [key: string]: unknown;
378
+ };
379
+ connectorId?: string;
380
+ name?: string;
381
+ /** @enum {string} */
382
+ provider: 'acumatica' | 'attio' | 'autodesk' | 'bigquery' | 'billcom' | 'brex' | 'double' | 'fireflies' | 'googleads' | 'granola' | 'hubspot' | 'klaviyo' | 'mercury' | 'meta_ads' | 'microsoft_advertising' | 'monday' | 'procore' | 'quickbooks' | 'quo' | 's3' | 'salesforce' | 'shopify' | 'stripe' | 'supabase' | 'tiktok_ads' | 'xero';
383
+ /** Format: uri */
384
+ returnUrl?: string;
385
+ } | {
386
+ config?: {
387
+ [key: string]: unknown;
388
+ };
389
+ connectorId: string;
390
+ name?: string;
391
+ /** @enum {string} */
392
+ provider?: 'acumatica' | 'attio' | 'autodesk' | 'bigquery' | 'billcom' | 'brex' | 'double' | 'fireflies' | 'googleads' | 'granola' | 'hubspot' | 'klaviyo' | 'mercury' | 'meta_ads' | 'microsoft_advertising' | 'monday' | 'procore' | 'quickbooks' | 'quo' | 's3' | 'salesforce' | 'shopify' | 'stripe' | 'supabase' | 'tiktok_ads' | 'xero';
393
+ /** Format: uri */
394
+ returnUrl?: string;
395
+ };
396
+ ConnectorSessionIdParams: {
397
+ sessionId: string;
398
+ };
127
399
  CustomDatasetResponse: {
128
400
  context: string[];
129
401
  /** Format: date-time */
@@ -186,6 +458,64 @@ export interface components {
186
458
  key: string;
187
459
  name: string;
188
460
  };
461
+ DatabaseDefinition: {
462
+ draft: {
463
+ definition: {
464
+ tables: {
465
+ columns: {
466
+ name: string;
467
+ /** @default false */
468
+ nullable: boolean;
469
+ /** @enum {string} */
470
+ type: 'text' | 'boolean' | 'bigint' | 'numeric' | 'uuid' | 'date' | 'timestamptz' | 'jsonb';
471
+ }[];
472
+ name: string;
473
+ primaryKey: string[];
474
+ }[];
475
+ };
476
+ revisionId: string;
477
+ sequence: number;
478
+ } | null;
479
+ published: {
480
+ definition: {
481
+ tables: {
482
+ columns: {
483
+ name: string;
484
+ /** @default false */
485
+ nullable: boolean;
486
+ /** @enum {string} */
487
+ type: 'text' | 'boolean' | 'bigint' | 'numeric' | 'uuid' | 'date' | 'timestamptz' | 'jsonb';
488
+ }[];
489
+ name: string;
490
+ primaryKey: string[];
491
+ }[];
492
+ };
493
+ revisionId: string;
494
+ sequence: number;
495
+ } | null;
496
+ };
497
+ DatabaseDefinitionSaved: {
498
+ revisionId: string;
499
+ };
500
+ DatabaseDefinitionSaveRequest: {
501
+ definition: {
502
+ tables: {
503
+ columns: {
504
+ name: string;
505
+ /** @default false */
506
+ nullable: boolean;
507
+ /** @enum {string} */
508
+ type: 'text' | 'boolean' | 'bigint' | 'numeric' | 'uuid' | 'date' | 'timestamptz' | 'jsonb';
509
+ }[];
510
+ name: string;
511
+ primaryKey: string[];
512
+ }[];
513
+ };
514
+ expectedDraft: {
515
+ revisionId: string;
516
+ sequence: number;
517
+ } | null;
518
+ };
189
519
  DatabaseIdParams: {
190
520
  databaseId: string;
191
521
  };
@@ -215,6 +545,7 @@ export interface components {
215
545
  };
216
546
  DatabaseTableCreated: {
217
547
  name: string;
548
+ revisionId: string;
218
549
  };
219
550
  DatabaseTableCreateRequest: {
220
551
  columns: {
@@ -256,7 +587,6 @@ export interface components {
256
587
  [key: string]: unknown;
257
588
  };
258
589
  } | {
259
- /** Format: uuid */
260
590
  expectedVersion: string;
261
591
  key: {
262
592
  [key: string]: unknown;
@@ -268,7 +598,6 @@ export interface components {
268
598
  [key: string]: unknown;
269
599
  };
270
600
  } | {
271
- /** Format: uuid */
272
601
  expectedVersion: string;
273
602
  key: {
274
603
  [key: string]: unknown;
@@ -941,8 +1270,19 @@ export interface components {
941
1270
  }[];
942
1271
  sourceIds: string[];
943
1272
  sql: string;
1273
+ timings?: {
1274
+ initializationMs: number;
1275
+ sourceLoadMs: number;
1276
+ sourceValidationMs: number;
1277
+ sqlExecutionMs: number;
1278
+ totalMs: number;
1279
+ };
944
1280
  truncated: boolean;
945
1281
  };
1282
+ ResourcePublishRequest: {
1283
+ expectedVersion: string;
1284
+ runId?: string;
1285
+ };
946
1286
  ResourceRevision: {
947
1287
  actor: {
948
1288
  id: string | null;
@@ -1129,6 +1469,11 @@ export interface components {
1129
1469
  provider?: string;
1130
1470
  }[];
1131
1471
  };
1472
+ SourceDetailQuery: {
1473
+ /** @enum {string} */
1474
+ includeFields?: 'true' | 'false';
1475
+ tableId?: string;
1476
+ };
1132
1477
  SourceIdParams: {
1133
1478
  sourceId: string;
1134
1479
  };
@@ -1214,6 +1559,301 @@ export interface components {
1214
1559
  context?: string;
1215
1560
  name?: string;
1216
1561
  };
1562
+ WriteSync: {
1563
+ /** Format: date-time */
1564
+ createdAt: string;
1565
+ definition: {
1566
+ destination: {
1567
+ object: string;
1568
+ resourceId: string;
1569
+ scope: string;
1570
+ };
1571
+ fields: {
1572
+ [key: string]: string;
1573
+ };
1574
+ input: {
1575
+ table: string;
1576
+ /** @enum {string} */
1577
+ type: 'source';
1578
+ } | {
1579
+ operationId: string;
1580
+ revisionId: string;
1581
+ table: string;
1582
+ /** @enum {string} */
1583
+ type: 'operation';
1584
+ };
1585
+ keyColumn: string;
1586
+ source: {
1587
+ object: string;
1588
+ resourceId: string;
1589
+ scope: string;
1590
+ };
1591
+ } | null;
1592
+ id: string;
1593
+ isEnabled: boolean;
1594
+ name: string;
1595
+ /** Format: date-time */
1596
+ updatedAt: string;
1597
+ version: number;
1598
+ };
1599
+ WriteSyncCreateRequest: {
1600
+ definition: {
1601
+ destination: {
1602
+ object: string;
1603
+ resourceId: string;
1604
+ scope: string;
1605
+ };
1606
+ fields: {
1607
+ [key: string]: string;
1608
+ };
1609
+ input: {
1610
+ table: string;
1611
+ /** @enum {string} */
1612
+ type: 'source';
1613
+ } | {
1614
+ operationId: string;
1615
+ revisionId: string;
1616
+ table: string;
1617
+ /** @enum {string} */
1618
+ type: 'operation';
1619
+ };
1620
+ keyColumn: string;
1621
+ source: {
1622
+ object: string;
1623
+ resourceId: string;
1624
+ scope: string;
1625
+ };
1626
+ };
1627
+ };
1628
+ WriteSyncDefinition: {
1629
+ destination: {
1630
+ object: string;
1631
+ resourceId: string;
1632
+ scope: string;
1633
+ };
1634
+ fields: {
1635
+ [key: string]: string;
1636
+ };
1637
+ input: {
1638
+ table: string;
1639
+ /** @enum {string} */
1640
+ type: 'source';
1641
+ } | {
1642
+ operationId: string;
1643
+ revisionId: string;
1644
+ table: string;
1645
+ /** @enum {string} */
1646
+ type: 'operation';
1647
+ };
1648
+ keyColumn: string;
1649
+ source: {
1650
+ object: string;
1651
+ resourceId: string;
1652
+ scope: string;
1653
+ };
1654
+ };
1655
+ WriteSyncDeleted: {
1656
+ deleted: boolean;
1657
+ };
1658
+ WriteSyncDestinations: {
1659
+ items: {
1660
+ id: string;
1661
+ name: string;
1662
+ objects: {
1663
+ fields: {
1664
+ label: string;
1665
+ name: string;
1666
+ /** @enum {string} */
1667
+ type: 'string' | 'array';
1668
+ }[];
1669
+ label: string;
1670
+ object: string;
1671
+ scope: string;
1672
+ }[];
1673
+ provider: string;
1674
+ }[];
1675
+ };
1676
+ WriteSyncDetail: {
1677
+ automaticEnabled: boolean;
1678
+ /** Format: date-time */
1679
+ createdAt: string;
1680
+ definition: {
1681
+ destination: {
1682
+ object: string;
1683
+ resourceId: string;
1684
+ scope: string;
1685
+ };
1686
+ fields: {
1687
+ [key: string]: string;
1688
+ };
1689
+ input: {
1690
+ table: string;
1691
+ /** @enum {string} */
1692
+ type: 'source';
1693
+ } | {
1694
+ operationId: string;
1695
+ revisionId: string;
1696
+ table: string;
1697
+ /** @enum {string} */
1698
+ type: 'operation';
1699
+ };
1700
+ keyColumn: string;
1701
+ source: {
1702
+ object: string;
1703
+ resourceId: string;
1704
+ scope: string;
1705
+ };
1706
+ } | null;
1707
+ id: string;
1708
+ identityLocked: boolean;
1709
+ isEnabled: boolean;
1710
+ name: string;
1711
+ /** Format: date-time */
1712
+ updatedAt: string;
1713
+ version: number;
1714
+ };
1715
+ WriteSyncExecution: {
1716
+ queued: boolean;
1717
+ runId: string;
1718
+ };
1719
+ WriteSyncIdParams: {
1720
+ writeSyncId: string;
1721
+ };
1722
+ WriteSyncList: {
1723
+ items: {
1724
+ /** Format: date-time */
1725
+ createdAt: string;
1726
+ definition: {
1727
+ destination: {
1728
+ object: string;
1729
+ resourceId: string;
1730
+ scope: string;
1731
+ };
1732
+ fields: {
1733
+ [key: string]: string;
1734
+ };
1735
+ input: {
1736
+ table: string;
1737
+ /** @enum {string} */
1738
+ type: 'source';
1739
+ } | {
1740
+ operationId: string;
1741
+ revisionId: string;
1742
+ table: string;
1743
+ /** @enum {string} */
1744
+ type: 'operation';
1745
+ };
1746
+ keyColumn: string;
1747
+ source: {
1748
+ object: string;
1749
+ resourceId: string;
1750
+ scope: string;
1751
+ };
1752
+ } | null;
1753
+ id: string;
1754
+ isEnabled: boolean;
1755
+ name: string;
1756
+ /** Format: date-time */
1757
+ updatedAt: string;
1758
+ version: number;
1759
+ }[];
1760
+ };
1761
+ WriteSyncRun: {
1762
+ automatic?: {
1763
+ /** Format: date-time */
1764
+ approvedAt: string;
1765
+ };
1766
+ definitionRevisionId?: string;
1767
+ definitionVersion: number;
1768
+ execution?: {
1769
+ /** Format: date-time */
1770
+ completedAt?: string;
1771
+ error?: string;
1772
+ /** Format: date-time */
1773
+ requestedAt: string;
1774
+ };
1775
+ id: string;
1776
+ page: number;
1777
+ pageCount: number;
1778
+ previewComplete: boolean;
1779
+ previewError?: string;
1780
+ recordCount: number;
1781
+ records: {
1782
+ /** @enum {string} */
1783
+ action?: 'create' | 'unchanged' | 'blocked';
1784
+ destinationId?: string;
1785
+ key: string;
1786
+ reason?: string;
1787
+ /** @enum {string} */
1788
+ status?: 'pending' | 'sending' | 'applied' | 'rejected' | 'unknown' | 'skipped';
1789
+ values: {
1790
+ [key: string]: unknown;
1791
+ };
1792
+ }[];
1793
+ sourceOperation?: {
1794
+ revisionId: string;
1795
+ runId: string;
1796
+ };
1797
+ writeSyncId: string;
1798
+ };
1799
+ WriteSyncRunList: {
1800
+ items: {
1801
+ automatic?: {
1802
+ /** Format: date-time */
1803
+ approvedAt: string;
1804
+ };
1805
+ /** Format: date-time */
1806
+ createdAt: string;
1807
+ execution?: {
1808
+ /** Format: date-time */
1809
+ completedAt?: string;
1810
+ error?: string;
1811
+ /** Format: date-time */
1812
+ requestedAt: string;
1813
+ };
1814
+ id: string;
1815
+ previewComplete: boolean;
1816
+ previewError?: string;
1817
+ recordCount: number;
1818
+ }[];
1819
+ };
1820
+ WriteSyncRunParams: {
1821
+ runId: string;
1822
+ writeSyncId: string;
1823
+ };
1824
+ WriteSyncRunQuery: {
1825
+ page?: number;
1826
+ };
1827
+ WriteSyncUpdateRequest: {
1828
+ definition: {
1829
+ destination: {
1830
+ object: string;
1831
+ resourceId: string;
1832
+ scope: string;
1833
+ };
1834
+ fields: {
1835
+ [key: string]: string;
1836
+ };
1837
+ input: {
1838
+ table: string;
1839
+ /** @enum {string} */
1840
+ type: 'source';
1841
+ } | {
1842
+ operationId: string;
1843
+ revisionId: string;
1844
+ table: string;
1845
+ /** @enum {string} */
1846
+ type: 'operation';
1847
+ };
1848
+ keyColumn: string;
1849
+ source: {
1850
+ object: string;
1851
+ resourceId: string;
1852
+ scope: string;
1853
+ };
1854
+ };
1855
+ expectedVersion: number;
1856
+ };
1217
1857
  };
1218
1858
  responses: never;
1219
1859
  parameters: never;