@permute/sdk 0.6.0 → 0.7.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.
@@ -19,13 +19,24 @@ export interface components {
19
19
  outputSchema: {
20
20
  [key: string]: unknown;
21
21
  };
22
+ platform?: {
23
+ methods: string[];
24
+ permissions: {
25
+ /** @enum {string} */
26
+ level: 'read' | 'write' | 'admin';
27
+ resourceId: string;
28
+ resourceType: string;
29
+ }[];
30
+ };
22
31
  source: string;
23
- sources: {
32
+ sources: ({
24
33
  readTables: string[];
25
34
  revisionId: string;
26
35
  sourceId: string;
27
36
  writeTables: string[];
28
- }[];
37
+ } | {
38
+ sourceId: string;
39
+ })[];
29
40
  };
30
41
  revisionId: string;
31
42
  sequence: number;
@@ -43,13 +54,24 @@ export interface components {
43
54
  outputSchema: {
44
55
  [key: string]: unknown;
45
56
  };
57
+ platform?: {
58
+ methods: string[];
59
+ permissions: {
60
+ /** @enum {string} */
61
+ level: 'read' | 'write' | 'admin';
62
+ resourceId: string;
63
+ resourceType: string;
64
+ }[];
65
+ };
46
66
  source: string;
47
- sources: {
67
+ sources: ({
48
68
  readTables: string[];
49
69
  revisionId: string;
50
70
  sourceId: string;
51
71
  writeTables: string[];
52
- }[];
72
+ } | {
73
+ sourceId: string;
74
+ })[];
53
75
  };
54
76
  revisionId: string;
55
77
  sequence: number;
@@ -71,13 +93,24 @@ export interface components {
71
93
  outputSchema: {
72
94
  [key: string]: unknown;
73
95
  };
96
+ platform?: {
97
+ methods: string[];
98
+ permissions: {
99
+ /** @enum {string} */
100
+ level: 'read' | 'write' | 'admin';
101
+ resourceId: string;
102
+ resourceType: string;
103
+ }[];
104
+ };
74
105
  source: string;
75
- sources: {
106
+ sources: ({
76
107
  readTables: string[];
77
108
  revisionId: string;
78
109
  sourceId: string;
79
110
  writeTables: string[];
80
- }[];
111
+ } | {
112
+ sourceId: string;
113
+ })[];
81
114
  };
82
115
  expectedDraft: {
83
116
  revisionId: string;
@@ -201,6 +234,45 @@ export interface components {
201
234
  message: string;
202
235
  requestId?: string;
203
236
  };
237
+ AppAccess: {
238
+ canManage: boolean;
239
+ /** @enum {string} */
240
+ mode: 'permute' | 'password';
241
+ version: number;
242
+ };
243
+ AppAccessSetRequest: {
244
+ expectedVersion: number;
245
+ /** @enum {string} */
246
+ mode: 'permute';
247
+ } | {
248
+ expectedVersion: number;
249
+ /** @enum {string} */
250
+ mode: 'password';
251
+ password: string;
252
+ };
253
+ AppAddressSetRequest: {
254
+ address: {
255
+ label: string;
256
+ namespaceId: string;
257
+ } | null;
258
+ /** Format: uri */
259
+ expectedUrl: string | null;
260
+ };
261
+ AppAddressSettings: {
262
+ address: {
263
+ label: string;
264
+ namespaceId: string;
265
+ /** Format: uri */
266
+ url: string;
267
+ } | null;
268
+ canManage: boolean;
269
+ namespaces: {
270
+ hostname: string;
271
+ id: string;
272
+ /** @enum {string} */
273
+ status: 'pending' | 'live' | 'failed' | 'deleting' | 'deleted';
274
+ }[];
275
+ };
204
276
  AppCreateRequest: {
205
277
  /** @default */
206
278
  description: string;
@@ -212,6 +284,9 @@ export interface components {
212
284
  id: string;
213
285
  };
214
286
  AppDraft: {
287
+ chat?: {
288
+ enabled: boolean;
289
+ };
215
290
  createdAt: string;
216
291
  deployment: {
217
292
  error: string | null;
@@ -226,13 +301,34 @@ export interface components {
226
301
  revisionId: string;
227
302
  sequence: number;
228
303
  };
304
+ favicon?: {
305
+ path: string;
306
+ sha256: string;
307
+ size: number;
308
+ } | null;
229
309
  id: string;
310
+ login?: {
311
+ header?: string;
312
+ primaryColor?: string;
313
+ secondaryColor?: string;
314
+ sidePanelImage?: {
315
+ path: string;
316
+ sha256: string;
317
+ size: number;
318
+ };
319
+ subheader?: string;
320
+ subtitle?: string;
321
+ title?: string;
322
+ } | null;
230
323
  name: string;
231
324
  updatedAt: string;
232
325
  workspaceId: string;
233
326
  };
234
327
  AppDraftList: {
235
328
  items: {
329
+ chat?: {
330
+ enabled: boolean;
331
+ };
236
332
  createdAt: string;
237
333
  deployment: {
238
334
  error: string | null;
@@ -247,7 +343,25 @@ export interface components {
247
343
  revisionId: string;
248
344
  sequence: number;
249
345
  };
346
+ favicon?: {
347
+ path: string;
348
+ sha256: string;
349
+ size: number;
350
+ } | null;
250
351
  id: string;
352
+ login?: {
353
+ header?: string;
354
+ primaryColor?: string;
355
+ secondaryColor?: string;
356
+ sidePanelImage?: {
357
+ path: string;
358
+ sha256: string;
359
+ size: number;
360
+ };
361
+ subheader?: string;
362
+ subtitle?: string;
363
+ title?: string;
364
+ } | null;
251
365
  name: string;
252
366
  updatedAt: string;
253
367
  workspaceId: string;
@@ -266,6 +380,7 @@ export interface components {
266
380
  level: 'read' | 'write' | 'admin';
267
381
  resourceId: string;
268
382
  resourceType?: string;
383
+ /** @description New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API. */
269
384
  subResourceId?: string;
270
385
  }[];
271
386
  };
@@ -275,6 +390,7 @@ export interface components {
275
390
  /** @enum {string|null} */
276
391
  level: 'read' | 'write' | 'admin' | null;
277
392
  resourceType?: string;
393
+ /** @description New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API. */
278
394
  subResourceId?: string;
279
395
  };
280
396
  AppIdParams: {
@@ -289,7 +405,7 @@ export interface components {
289
405
  revisionId: string;
290
406
  sequence: number;
291
407
  };
292
- site: {
408
+ site?: {
293
409
  files: {
294
410
  path: string;
295
411
  sha256: string;
@@ -297,14 +413,55 @@ export interface components {
297
413
  }[];
298
414
  spa: boolean;
299
415
  };
416
+ source: {
417
+ build: {
418
+ command: string;
419
+ outputDirectory: string;
420
+ runtime: string;
421
+ };
422
+ files: {
423
+ executable?: boolean;
424
+ path: string;
425
+ sha256: string;
426
+ size: number;
427
+ }[];
428
+ };
429
+ };
430
+ AppSourceFileContent: {
431
+ data: string;
432
+ };
433
+ AppSourceFileQuery: {
434
+ path: string;
435
+ revisionId: string;
300
436
  };
301
437
  AppUpdateRequest: {
302
- description: string;
438
+ chat?: {
439
+ enabled: boolean;
440
+ };
441
+ description?: string;
303
442
  expectedDraft: {
304
443
  revisionId: string;
305
444
  sequence: number;
306
445
  };
307
- name: string;
446
+ favicon?: {
447
+ path: string;
448
+ sha256: string;
449
+ size: number;
450
+ } | null;
451
+ login?: {
452
+ header?: string;
453
+ primaryColor?: string;
454
+ secondaryColor?: string;
455
+ sidePanelImage?: {
456
+ path: string;
457
+ sha256: string;
458
+ size: number;
459
+ };
460
+ subheader?: string;
461
+ subtitle?: string;
462
+ title?: string;
463
+ } | null;
464
+ name?: string;
308
465
  };
309
466
  AppUploads: {
310
467
  uploads: {
@@ -323,6 +480,11 @@ export interface components {
323
480
  size: number;
324
481
  }[];
325
482
  };
483
+ AppUser: {
484
+ email: string;
485
+ id: string;
486
+ name: string;
487
+ };
326
488
  BusinessAction: {
327
489
  createdAt: string;
328
490
  id: string;
@@ -371,8 +533,164 @@ export interface components {
371
533
  name: string;
372
534
  provider?: string;
373
535
  };
536
+ ChatDecisionRequest: {
537
+ approve: boolean;
538
+ /** Format: uuid */
539
+ requestId: string;
540
+ };
541
+ ChatIdParams: {
542
+ chatId: string;
543
+ };
544
+ ChatResponse: {
545
+ conversation: ({
546
+ citations?: {
547
+ datasetId: string;
548
+ page: number;
549
+ quote?: string;
550
+ reason?: string;
551
+ }[];
552
+ content: string;
553
+ meta?: {
554
+ appAction?: {
555
+ actionId: string;
556
+ input: {
557
+ [key: string]: unknown;
558
+ };
559
+ name: string;
560
+ /** Format: uuid */
561
+ requestId: string;
562
+ /** @enum {string} */
563
+ status: 'pending' | 'dismissed' | 'completed';
564
+ };
565
+ } & {
566
+ [key: string]: unknown;
567
+ };
568
+ /** @enum {string} */
569
+ role: 'user' | 'assistant';
570
+ tableCitations?: {
571
+ datasetId: string;
572
+ id: number;
573
+ page: string;
574
+ queryDetails?: {
575
+ connectorId: string;
576
+ detailSql?: string;
577
+ provider: string;
578
+ retrievedAt?: string;
579
+ rowCount?: number;
580
+ sources?: {
581
+ id: string;
582
+ name: string;
583
+ provider?: string;
584
+ }[];
585
+ sourceTables?: string[];
586
+ sql: string;
587
+ };
588
+ sampleData?: {
589
+ columns: string[];
590
+ rows: unknown[][];
591
+ };
592
+ tableDescription: string;
593
+ }[];
594
+ timestamp?: string;
595
+ } & {
596
+ [key: string]: unknown;
597
+ })[];
598
+ error: string | null;
599
+ id: string;
600
+ pendingTask?: {
601
+ actionOutputId?: string | null;
602
+ actionType: string;
603
+ description?: string;
604
+ draft: {
605
+ chatHistory?: {
606
+ content: string;
607
+ /** @enum {string} */
608
+ role: 'user' | 'assistant';
609
+ }[];
610
+ /** @default [] */
611
+ dataSourceIds: string[];
612
+ instructions: string;
613
+ isDraft?: boolean;
614
+ metadata?: {
615
+ /** @enum {string} */
616
+ subtype?: 'report' | 'dashboard' | 'dataFlow' | 'dataTable';
617
+ wizardState?: {
618
+ [key: string]: unknown;
619
+ };
620
+ } & {
621
+ [key: string]: unknown;
622
+ };
623
+ name?: string;
624
+ outputSchema?: {
625
+ columns: {
626
+ name: string;
627
+ type: string;
628
+ }[];
629
+ name: string;
630
+ }[];
631
+ schedule?: {
632
+ /** @enum {string} */
633
+ type: 'manual';
634
+ } | {
635
+ minute: number;
636
+ /** @enum {string} */
637
+ type: 'hourly';
638
+ } | {
639
+ hour: number;
640
+ minute: number;
641
+ /** @enum {string} */
642
+ type: 'daily';
643
+ } | {
644
+ dayOfWeek: number;
645
+ hour: number;
646
+ minute: number;
647
+ /** @enum {string} */
648
+ type: 'weekly';
649
+ } | {
650
+ dayOfMonth: number;
651
+ hour: number;
652
+ minute: number;
653
+ /** @enum {string} */
654
+ type: 'monthly';
655
+ };
656
+ };
657
+ id: string;
658
+ /** @enum {string} */
659
+ kind: 'report' | 'dashboard' | 'dataFlow' | 'dataTable';
660
+ /** @enum {string} */
661
+ status: 'pending' | 'open' | 'in_progress' | 'done' | 'cancelled';
662
+ title: string;
663
+ };
664
+ startedAt?: string;
665
+ /** @enum {string} */
666
+ status: 'running' | 'waiting' | 'completed' | 'failed' | 'cancelled';
667
+ traceSteps?: {
668
+ details?: string;
669
+ id: string;
670
+ /** @enum {string} */
671
+ kind: 'trace_step';
672
+ /** @enum {string} */
673
+ status: 'in_progress' | 'completed' | 'failed';
674
+ step: string;
675
+ }[];
676
+ };
677
+ ChatSendRequest: {
678
+ /** @enum {string} */
679
+ action: 'send_message';
680
+ attachments?: {
681
+ fileName: string;
682
+ id: string;
683
+ /** @enum {string} */
684
+ mimeType: 'image/png' | 'image/jpeg' | 'image/gif' | 'image/webp';
685
+ s3Key: string;
686
+ }[];
687
+ clientRequestId: string;
688
+ contexts?: string[];
689
+ message: string;
690
+ timeZone?: string;
691
+ };
374
692
  /** @enum {string} */
375
- 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';
693
+ ConnectorProviderId: 'acumatica' | 'amazon_seller_central' | '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';
376
694
  ConnectorSession: {
377
695
  connectorId: string;
378
696
  connectorStatus: string;
@@ -402,7 +720,7 @@ export interface components {
402
720
  connectorId?: string;
403
721
  name?: string;
404
722
  /** @enum {string} */
405
- 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';
723
+ provider: 'acumatica' | 'amazon_seller_central' | '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';
406
724
  /** Format: uri */
407
725
  returnUrl?: string;
408
726
  } | {
@@ -412,7 +730,7 @@ export interface components {
412
730
  connectorId: string;
413
731
  name?: string;
414
732
  /** @enum {string} */
415
- 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';
733
+ provider?: 'acumatica' | 'amazon_seller_central' | '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';
416
734
  /** Format: uri */
417
735
  returnUrl?: string;
418
736
  };
@@ -8,10 +8,11 @@ export interface RuntimeRoute {
8
8
  querySchema: JsonSchema | null;
9
9
  responseSchema: JsonSchema;
10
10
  }
11
- export type PublicApiOperationId = 'connectorSessionsCreate' | 'connectorSessionsGet' | 'resourceRevisionsList' | 'resourceRevisionsGet' | 'resourceRevisionsRestore' | 'resourcesPublish' | 'actionsList' | 'actionsCreate' | 'actionsGet' | 'actionsDelete' | 'actionDefinitionGet' | 'actionDefinitionSave' | 'actionsInvoke' | 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'dashboardsSourceGet' | 'dashboardsSourceUpdate' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsDelete' | 'datasetsDownload' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate' | 'operationRunsList' | 'operationsList' | 'operationsGet' | 'operationsUpdate' | 'operationsSourceGet' | 'operationsSourceUpdate' | 'operationsRunsList' | 'operationsRun' | 'operationsRunOutput' | 'dataFlowsCreate' | 'dataFlowsGet' | 'dataFlowsCommand' | 'factsList' | 'factsCreate' | 'factsGet' | 'factsUpdate' | 'factsDelete' | 'skillsList' | 'skillsGet' | 'skillsUpdate' | 'skillsDelete' | 'organizationSkillsList' | 'organizationSkillsGet' | 'organizationSkillsUpdate' | 'organizationSkillsDelete' | 'databasesList' | 'databasesCreate' | 'databasesGet' | 'databasesDelete' | 'databaseDefinitionGet' | 'databaseDefinitionSave' | 'databaseTablesList' | 'databaseTablesCreate' | 'databaseRecordsList' | 'databaseTransactionsCreate' | 'appsGrantsList' | 'appsGrantsSet' | 'appsList' | 'appsCreate' | 'appsGet' | 'appsUpdate' | 'appsDelete' | 'appsUploadsCreate' | 'appsSiteUpdate' | 'writeSyncsList' | 'writeSyncsCreate' | 'writeSyncsDestinations' | 'writeSyncsGet' | 'writeSyncsUpdate' | 'writeSyncsDelete' | 'writeSyncsPreview' | 'writeSyncsPause' | 'writeSyncsListRuns' | 'writeSyncsGetRun' | 'writeSyncsExecute';
11
+ export type PublicApiOperationId = 'connectorSessionsCreate' | 'connectorSessionsGet' | 'resourceRevisionsList' | 'resourceRevisionsGet' | 'resourceRevisionsRestore' | 'resourcesPublish' | 'actionsList' | 'actionsCreate' | 'actionsGet' | 'actionsDelete' | 'actionDefinitionGet' | 'actionDefinitionSave' | 'actionsInvoke' | 'chatsCreate' | 'chatsGet' | 'chatTurnsCreate' | 'chatsStop' | 'chatDecisionsCreate' | 'usersMe' | 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'dashboardsSourceGet' | 'dashboardsSourceUpdate' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsDelete' | 'datasetsDownload' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate' | 'operationRunsList' | 'operationsList' | 'operationsGet' | 'operationsUpdate' | 'operationsSourceGet' | 'operationsSourceUpdate' | 'operationsRunsList' | 'operationsRun' | 'operationsRunOutput' | 'dataFlowsCreate' | 'dataFlowsGet' | 'dataFlowsCommand' | 'factsList' | 'factsCreate' | 'factsGet' | 'factsUpdate' | 'factsDelete' | 'skillsList' | 'skillsGet' | 'skillsUpdate' | 'skillsDelete' | 'organizationSkillsList' | 'organizationSkillsGet' | 'organizationSkillsUpdate' | 'organizationSkillsDelete' | 'databasesList' | 'databasesCreate' | 'databasesGet' | 'databasesDelete' | 'databaseDefinitionGet' | 'databaseDefinitionSave' | 'databaseTablesList' | 'databaseTablesCreate' | 'databaseRecordsList' | 'databaseTransactionsCreate' | 'appsSourceFileGet' | 'appsAddressGet' | 'appsAddressSet' | 'appsAccessGet' | 'appsAccessSet' | 'appsGrantsList' | 'appsGrantsSet' | 'appsList' | 'appsCreate' | 'appsGet' | 'appsUpdate' | 'appsDelete' | 'appsUploadsCreate' | 'appsSiteUpdate' | 'writeSyncsList' | 'writeSyncsCreate' | 'writeSyncsDestinations' | 'writeSyncsGet' | 'writeSyncsUpdate' | 'writeSyncsDelete' | 'writeSyncsPreview' | 'writeSyncsPause' | 'writeSyncsListRuns' | 'writeSyncsGetRun' | 'writeSyncsExecute';
12
12
  export declare const publicApiRoutes: Record<PublicApiOperationId, RuntimeRoute>;
13
13
  export declare const Providers: {
14
14
  readonly ACUMATICA: "acumatica";
15
+ readonly AMAZON_SELLER_CENTRAL: "amazon_seller_central";
15
16
  readonly ATTIO: "attio";
16
17
  readonly AUTODESK: "autodesk";
17
18
  readonly BIGQUERY: "bigquery";