@permute/sdk 0.7.0 → 0.8.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.
- package/README.md +139 -13
- package/dist/app.d.ts +8 -0
- package/dist/app.js +6 -0
- package/dist/auth/oauth.d.ts +64 -0
- package/dist/auth/oauth.js +221 -0
- package/dist/auth/store.d.ts +39 -0
- package/dist/auth/store.js +70 -0
- package/dist/auth.d.ts +1 -0
- package/dist/auth.js +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +127 -0
- package/dist/client.d.ts +40 -14
- package/dist/client.js +32 -3
- package/dist/deploy.d.ts +1 -1
- package/dist/generated/openapi.d.ts +401 -9
- package/dist/generated/runtime-contract.d.ts +34 -28
- package/dist/generated/runtime-contract.js +98 -75
- package/dist/index.d.ts +15 -15
- package/dist/types.d.ts +28 -1
- package/package.json +14 -3
|
@@ -2,6 +2,76 @@ export type paths = Record<string, never>;
|
|
|
2
2
|
export type webhooks = Record<string, never>;
|
|
3
3
|
export interface components {
|
|
4
4
|
schemas: {
|
|
5
|
+
AccessRequest: {
|
|
6
|
+
applicationId?: string;
|
|
7
|
+
/** Format: date-time */
|
|
8
|
+
createdAt: string;
|
|
9
|
+
/** Format: date-time */
|
|
10
|
+
expiresAt: string;
|
|
11
|
+
id: string;
|
|
12
|
+
/** @enum {string} */
|
|
13
|
+
level?: 'read' | 'write' | 'admin';
|
|
14
|
+
operations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
15
|
+
principalId: string;
|
|
16
|
+
/** @enum {string} */
|
|
17
|
+
principalType: 'user' | 'apiKey';
|
|
18
|
+
reason: string;
|
|
19
|
+
resourceId: string;
|
|
20
|
+
resourceType: string;
|
|
21
|
+
/** @enum {string} */
|
|
22
|
+
status: 'pending' | 'approved' | 'resolved' | 'rejected' | 'cancelled' | 'expired';
|
|
23
|
+
};
|
|
24
|
+
AccessRequestDecision: {
|
|
25
|
+
/** @enum {string} */
|
|
26
|
+
decision: 'approved' | 'resolved' | 'rejected' | 'cancelled';
|
|
27
|
+
};
|
|
28
|
+
AccessRequestInput: {
|
|
29
|
+
/** @enum {string} */
|
|
30
|
+
level: 'read' | 'write' | 'admin';
|
|
31
|
+
reason: string;
|
|
32
|
+
resourceId: string;
|
|
33
|
+
} | {
|
|
34
|
+
operations: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
35
|
+
reason: string;
|
|
36
|
+
resourceId: string;
|
|
37
|
+
};
|
|
38
|
+
AccessRequestList: {
|
|
39
|
+
items: {
|
|
40
|
+
applicationId?: string;
|
|
41
|
+
/** Format: date-time */
|
|
42
|
+
createdAt: string;
|
|
43
|
+
/** Format: date-time */
|
|
44
|
+
expiresAt: string;
|
|
45
|
+
id: string;
|
|
46
|
+
/** @enum {string} */
|
|
47
|
+
level?: 'read' | 'write' | 'admin';
|
|
48
|
+
operations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
49
|
+
principalId: string;
|
|
50
|
+
/** @enum {string} */
|
|
51
|
+
principalType: 'user' | 'apiKey';
|
|
52
|
+
reason: string;
|
|
53
|
+
resourceId: string;
|
|
54
|
+
resourceType: string;
|
|
55
|
+
/** @enum {string} */
|
|
56
|
+
status: 'pending' | 'approved' | 'resolved' | 'rejected' | 'cancelled' | 'expired';
|
|
57
|
+
}[];
|
|
58
|
+
nextCursor: string | null;
|
|
59
|
+
total: number;
|
|
60
|
+
};
|
|
61
|
+
AccessRequestParams: {
|
|
62
|
+
requestId: string;
|
|
63
|
+
};
|
|
64
|
+
AccessRequestQuery: {
|
|
65
|
+
cursor?: string;
|
|
66
|
+
resourceId?: string;
|
|
67
|
+
/** @enum {string} */
|
|
68
|
+
state?: 'pending' | 'closed';
|
|
69
|
+
/**
|
|
70
|
+
* @default mine
|
|
71
|
+
* @enum {string}
|
|
72
|
+
*/
|
|
73
|
+
view: 'mine' | 'review' | 'history';
|
|
74
|
+
};
|
|
5
75
|
ActionCreateRequest: {
|
|
6
76
|
name: string;
|
|
7
77
|
};
|
|
@@ -14,7 +84,10 @@ export interface components {
|
|
|
14
84
|
inputSchema: {
|
|
15
85
|
[key: string]: unknown;
|
|
16
86
|
};
|
|
17
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* @description Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold.
|
|
89
|
+
* @enum {string}
|
|
90
|
+
*/
|
|
18
91
|
invokePermission: 'read' | 'write' | 'admin';
|
|
19
92
|
outputSchema: {
|
|
20
93
|
[key: string]: unknown;
|
|
@@ -49,7 +122,10 @@ export interface components {
|
|
|
49
122
|
inputSchema: {
|
|
50
123
|
[key: string]: unknown;
|
|
51
124
|
};
|
|
52
|
-
/**
|
|
125
|
+
/**
|
|
126
|
+
* @description Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold.
|
|
127
|
+
* @enum {string}
|
|
128
|
+
*/
|
|
53
129
|
invokePermission: 'read' | 'write' | 'admin';
|
|
54
130
|
outputSchema: {
|
|
55
131
|
[key: string]: unknown;
|
|
@@ -76,6 +152,7 @@ export interface components {
|
|
|
76
152
|
revisionId: string;
|
|
77
153
|
sequence: number;
|
|
78
154
|
} | null;
|
|
155
|
+
version: string;
|
|
79
156
|
};
|
|
80
157
|
ActionDefinitionSaved: {
|
|
81
158
|
revisionId: string;
|
|
@@ -88,7 +165,10 @@ export interface components {
|
|
|
88
165
|
inputSchema: {
|
|
89
166
|
[key: string]: unknown;
|
|
90
167
|
};
|
|
91
|
-
/**
|
|
168
|
+
/**
|
|
169
|
+
* @description Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold.
|
|
170
|
+
* @enum {string}
|
|
171
|
+
*/
|
|
92
172
|
invokePermission: 'read' | 'write' | 'admin';
|
|
93
173
|
outputSchema: {
|
|
94
174
|
[key: string]: unknown;
|
|
@@ -120,6 +200,57 @@ export interface components {
|
|
|
120
200
|
ActionIdParams: {
|
|
121
201
|
actionId: string;
|
|
122
202
|
};
|
|
203
|
+
ActionPublicationDecision: {
|
|
204
|
+
/** @enum {string} */
|
|
205
|
+
decision: 'approved' | 'rejected' | 'cancelled';
|
|
206
|
+
};
|
|
207
|
+
ActionPublicationRequest: {
|
|
208
|
+
actionId: string;
|
|
209
|
+
canCancel: boolean;
|
|
210
|
+
canPublish: boolean;
|
|
211
|
+
/** Format: date-time */
|
|
212
|
+
createdAt: string;
|
|
213
|
+
expectedVersion: string;
|
|
214
|
+
/** Format: date-time */
|
|
215
|
+
expiresAt: string;
|
|
216
|
+
id: string;
|
|
217
|
+
principalId: string;
|
|
218
|
+
/** @enum {string} */
|
|
219
|
+
principalType: 'user' | 'apiKey';
|
|
220
|
+
reason: string;
|
|
221
|
+
revisionId: string;
|
|
222
|
+
/** @enum {string} */
|
|
223
|
+
status: 'pending' | 'published' | 'rejected' | 'cancelled' | 'expired' | 'stale';
|
|
224
|
+
};
|
|
225
|
+
ActionPublicationRequestInput: {
|
|
226
|
+
expectedVersion: string;
|
|
227
|
+
reason?: string;
|
|
228
|
+
revisionId: string;
|
|
229
|
+
};
|
|
230
|
+
ActionPublicationRequestList: {
|
|
231
|
+
items: {
|
|
232
|
+
actionId: string;
|
|
233
|
+
canCancel: boolean;
|
|
234
|
+
canPublish: boolean;
|
|
235
|
+
/** Format: date-time */
|
|
236
|
+
createdAt: string;
|
|
237
|
+
expectedVersion: string;
|
|
238
|
+
/** Format: date-time */
|
|
239
|
+
expiresAt: string;
|
|
240
|
+
id: string;
|
|
241
|
+
principalId: string;
|
|
242
|
+
/** @enum {string} */
|
|
243
|
+
principalType: 'user' | 'apiKey';
|
|
244
|
+
reason: string;
|
|
245
|
+
revisionId: string;
|
|
246
|
+
/** @enum {string} */
|
|
247
|
+
status: 'pending' | 'published' | 'rejected' | 'cancelled' | 'expired' | 'stale';
|
|
248
|
+
}[];
|
|
249
|
+
};
|
|
250
|
+
ActionPublicationRequestParams: {
|
|
251
|
+
actionId: string;
|
|
252
|
+
requestId: string;
|
|
253
|
+
};
|
|
123
254
|
ActionReceipt: {
|
|
124
255
|
actionId: string;
|
|
125
256
|
output?: unknown;
|
|
@@ -380,7 +511,7 @@ export interface components {
|
|
|
380
511
|
level: 'read' | 'write' | 'admin';
|
|
381
512
|
resourceId: string;
|
|
382
513
|
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. */
|
|
514
|
+
/** @description New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API. */
|
|
384
515
|
subResourceId?: string;
|
|
385
516
|
}[];
|
|
386
517
|
};
|
|
@@ -390,12 +521,63 @@ export interface components {
|
|
|
390
521
|
/** @enum {string|null} */
|
|
391
522
|
level: 'read' | 'write' | 'admin' | null;
|
|
392
523
|
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. */
|
|
524
|
+
/** @description New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API. */
|
|
394
525
|
subResourceId?: string;
|
|
395
526
|
};
|
|
396
527
|
AppIdParams: {
|
|
397
528
|
applicationId: string;
|
|
398
529
|
};
|
|
530
|
+
AppPublicationDecision: {
|
|
531
|
+
/** @enum {string} */
|
|
532
|
+
decision: 'approved' | 'rejected' | 'cancelled';
|
|
533
|
+
};
|
|
534
|
+
AppPublicationRequest: {
|
|
535
|
+
applicationId: string;
|
|
536
|
+
canCancel: boolean;
|
|
537
|
+
canPublish: boolean;
|
|
538
|
+
/** Format: date-time */
|
|
539
|
+
createdAt: string;
|
|
540
|
+
expectedVersion: string;
|
|
541
|
+
/** Format: date-time */
|
|
542
|
+
expiresAt: string;
|
|
543
|
+
id: string;
|
|
544
|
+
principalId: string;
|
|
545
|
+
/** @enum {string} */
|
|
546
|
+
principalType: 'user' | 'apiKey';
|
|
547
|
+
reason: string;
|
|
548
|
+
revisionId: string;
|
|
549
|
+
/** @enum {string} */
|
|
550
|
+
status: 'pending' | 'published' | 'rejected' | 'cancelled' | 'expired' | 'stale';
|
|
551
|
+
};
|
|
552
|
+
AppPublicationRequestInput: {
|
|
553
|
+
expectedVersion: string;
|
|
554
|
+
reason?: string;
|
|
555
|
+
revisionId: string;
|
|
556
|
+
};
|
|
557
|
+
AppPublicationRequestList: {
|
|
558
|
+
items: {
|
|
559
|
+
applicationId: string;
|
|
560
|
+
canCancel: boolean;
|
|
561
|
+
canPublish: boolean;
|
|
562
|
+
/** Format: date-time */
|
|
563
|
+
createdAt: string;
|
|
564
|
+
expectedVersion: string;
|
|
565
|
+
/** Format: date-time */
|
|
566
|
+
expiresAt: string;
|
|
567
|
+
id: string;
|
|
568
|
+
principalId: string;
|
|
569
|
+
/** @enum {string} */
|
|
570
|
+
principalType: 'user' | 'apiKey';
|
|
571
|
+
reason: string;
|
|
572
|
+
revisionId: string;
|
|
573
|
+
/** @enum {string} */
|
|
574
|
+
status: 'pending' | 'published' | 'rejected' | 'cancelled' | 'expired' | 'stale';
|
|
575
|
+
}[];
|
|
576
|
+
};
|
|
577
|
+
AppPublicationRequestParams: {
|
|
578
|
+
applicationId: string;
|
|
579
|
+
requestId: string;
|
|
580
|
+
};
|
|
399
581
|
AppSiteSaveRequest: {
|
|
400
582
|
actions?: {
|
|
401
583
|
actionId: string;
|
|
@@ -492,13 +674,51 @@ export interface components {
|
|
|
492
674
|
updatedAt: string;
|
|
493
675
|
workspaceId: string;
|
|
494
676
|
};
|
|
677
|
+
BusinessActionDetail: {
|
|
678
|
+
canEditDraft?: boolean;
|
|
679
|
+
canPublish?: boolean;
|
|
680
|
+
contract: {
|
|
681
|
+
effects: {
|
|
682
|
+
connectorCalls: boolean;
|
|
683
|
+
managedDataWrites: boolean;
|
|
684
|
+
platformMethods: string[];
|
|
685
|
+
};
|
|
686
|
+
inputSchema: {
|
|
687
|
+
[key: string]: unknown;
|
|
688
|
+
};
|
|
689
|
+
/**
|
|
690
|
+
* @description Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold.
|
|
691
|
+
* @enum {string}
|
|
692
|
+
*/
|
|
693
|
+
invokePermission: 'read' | 'write' | 'admin';
|
|
694
|
+
outputSchema: {
|
|
695
|
+
[key: string]: unknown;
|
|
696
|
+
};
|
|
697
|
+
} | null;
|
|
698
|
+
createdAt: string;
|
|
699
|
+
id: string;
|
|
700
|
+
name: string;
|
|
701
|
+
revisionId: string | null;
|
|
702
|
+
updatedAt: string;
|
|
703
|
+
workspaceId: string;
|
|
704
|
+
};
|
|
495
705
|
BusinessActionList: {
|
|
496
706
|
items: {
|
|
707
|
+
canEditDraft?: boolean;
|
|
708
|
+
canPublish?: boolean;
|
|
497
709
|
contract: {
|
|
710
|
+
effects: {
|
|
711
|
+
connectorCalls: boolean;
|
|
712
|
+
managedDataWrites: boolean;
|
|
713
|
+
platformMethods: string[];
|
|
714
|
+
};
|
|
498
715
|
inputSchema: {
|
|
499
716
|
[key: string]: unknown;
|
|
500
717
|
};
|
|
501
|
-
/**
|
|
718
|
+
/**
|
|
719
|
+
* @description Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold.
|
|
720
|
+
* @enum {string}
|
|
721
|
+
*/
|
|
502
722
|
invokePermission: 'read' | 'write' | 'admin';
|
|
503
723
|
outputSchema: {
|
|
504
724
|
[key: string]: unknown;
|
|
@@ -690,7 +910,7 @@ export interface components {
|
|
|
690
910
|
timeZone?: string;
|
|
691
911
|
};
|
|
692
912
|
/** @enum {string} */
|
|
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';
|
|
913
|
+
ConnectorProviderId: 'acumatica' | 'amazon_ads' | 'amazon_seller_central' | 'attio' | 'autodesk' | 'bigquery' | 'billcom' | 'brex' | 'double' | 'fireflies' | 'gmail' | 'googleads' | 'granola' | 'hubspot' | 'instantly' | 'klaviyo' | 'mercury' | 'meta_ads' | 'microsoft_advertising' | 'monday' | 'procore' | 'pylon' | 'quickbooks' | 'quo' | 's3' | 'salesforce' | 'shopify' | 'stripe' | 'supabase' | 'tiktok_ads' | 'tiktok_shop' | 'xero' | 'yardi';
|
|
694
914
|
ConnectorSession: {
|
|
695
915
|
connectorId: string;
|
|
696
916
|
connectorStatus: string;
|
|
@@ -720,7 +940,7 @@ export interface components {
|
|
|
720
940
|
connectorId?: string;
|
|
721
941
|
name?: string;
|
|
722
942
|
/** @enum {string} */
|
|
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';
|
|
943
|
+
provider: 'acumatica' | 'amazon_ads' | 'amazon_seller_central' | 'attio' | 'autodesk' | 'bigquery' | 'billcom' | 'brex' | 'double' | 'fireflies' | 'gmail' | 'googleads' | 'granola' | 'hubspot' | 'instantly' | 'klaviyo' | 'mercury' | 'meta_ads' | 'microsoft_advertising' | 'monday' | 'procore' | 'pylon' | 'quickbooks' | 'quo' | 's3' | 'salesforce' | 'shopify' | 'stripe' | 'supabase' | 'tiktok_ads' | 'tiktok_shop' | 'xero' | 'yardi';
|
|
724
944
|
/** Format: uri */
|
|
725
945
|
returnUrl?: string;
|
|
726
946
|
} | {
|
|
@@ -730,7 +950,7 @@ export interface components {
|
|
|
730
950
|
connectorId: string;
|
|
731
951
|
name?: string;
|
|
732
952
|
/** @enum {string} */
|
|
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';
|
|
953
|
+
provider?: 'acumatica' | 'amazon_ads' | 'amazon_seller_central' | 'attio' | 'autodesk' | 'bigquery' | 'billcom' | 'brex' | 'double' | 'fireflies' | 'gmail' | 'googleads' | 'granola' | 'hubspot' | 'instantly' | 'klaviyo' | 'mercury' | 'meta_ads' | 'microsoft_advertising' | 'monday' | 'procore' | 'pylon' | 'quickbooks' | 'quo' | 's3' | 'salesforce' | 'shopify' | 'stripe' | 'supabase' | 'tiktok_ads' | 'tiktok_shop' | 'xero' | 'yardi';
|
|
734
954
|
/** Format: uri */
|
|
735
955
|
returnUrl?: string;
|
|
736
956
|
};
|
|
@@ -1255,6 +1475,24 @@ export interface components {
|
|
|
1255
1475
|
status: 'pending' | 'processing' | 'completed' | 'failed';
|
|
1256
1476
|
};
|
|
1257
1477
|
};
|
|
1478
|
+
EmailReceipt: {
|
|
1479
|
+
id: string;
|
|
1480
|
+
/** @enum {string} */
|
|
1481
|
+
status: 'accepted';
|
|
1482
|
+
};
|
|
1483
|
+
EmailSender: {
|
|
1484
|
+
address: string & string;
|
|
1485
|
+
error: string | null;
|
|
1486
|
+
id: string;
|
|
1487
|
+
/** @enum {string} */
|
|
1488
|
+
status: 'provisioning' | 'ready' | 'failed';
|
|
1489
|
+
};
|
|
1490
|
+
EmailSendRequest: {
|
|
1491
|
+
html?: string;
|
|
1492
|
+
subject: string;
|
|
1493
|
+
text: string;
|
|
1494
|
+
to: (string & string)[];
|
|
1495
|
+
};
|
|
1258
1496
|
EmptyObject: Record<string, never>;
|
|
1259
1497
|
Fact: {
|
|
1260
1498
|
aliases?: string | null;
|
|
@@ -1593,6 +1831,160 @@ export interface components {
|
|
|
1593
1831
|
type: 'monthly';
|
|
1594
1832
|
}) | (never | null);
|
|
1595
1833
|
};
|
|
1834
|
+
PermissionGrant: {
|
|
1835
|
+
/** Format: date-time */
|
|
1836
|
+
createdAt: string;
|
|
1837
|
+
/** Format: date-time */
|
|
1838
|
+
expiresAt: string | null;
|
|
1839
|
+
grantedBy: string;
|
|
1840
|
+
id: string;
|
|
1841
|
+
/** @enum {string} */
|
|
1842
|
+
level: 'read' | 'write' | 'admin';
|
|
1843
|
+
operations: string[] | null;
|
|
1844
|
+
organizationId: string;
|
|
1845
|
+
principalId: string;
|
|
1846
|
+
principalType: string;
|
|
1847
|
+
resourceId: string;
|
|
1848
|
+
resourceType: string;
|
|
1849
|
+
subResourceId: string | null;
|
|
1850
|
+
/** Format: date-time */
|
|
1851
|
+
updatedAt: string;
|
|
1852
|
+
workspaceId: string | null;
|
|
1853
|
+
};
|
|
1854
|
+
PermissionGrantInput: {
|
|
1855
|
+
/** Format: date-time */
|
|
1856
|
+
expiresAt?: string | null;
|
|
1857
|
+
/** @enum {string} */
|
|
1858
|
+
level: 'read' | 'write' | 'admin';
|
|
1859
|
+
operations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
1860
|
+
principalId: string;
|
|
1861
|
+
/** @enum {string} */
|
|
1862
|
+
principalType: 'user' | 'workspace' | 'organization' | 'apiKey' | 'application';
|
|
1863
|
+
resourceId: string;
|
|
1864
|
+
resourceType: string;
|
|
1865
|
+
/** @description New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API. */
|
|
1866
|
+
subResourceId?: string;
|
|
1867
|
+
};
|
|
1868
|
+
PermissionGrantList: {
|
|
1869
|
+
items: {
|
|
1870
|
+
/** Format: date-time */
|
|
1871
|
+
createdAt: string;
|
|
1872
|
+
/** Format: date-time */
|
|
1873
|
+
expiresAt: string | null;
|
|
1874
|
+
grantedBy: string;
|
|
1875
|
+
id: string;
|
|
1876
|
+
/** @enum {string} */
|
|
1877
|
+
level: 'read' | 'write' | 'admin';
|
|
1878
|
+
operations: string[] | null;
|
|
1879
|
+
organizationId: string;
|
|
1880
|
+
principalId: string;
|
|
1881
|
+
principalType: string;
|
|
1882
|
+
resourceId: string;
|
|
1883
|
+
resourceType: string;
|
|
1884
|
+
subResourceId: string | null;
|
|
1885
|
+
/** Format: date-time */
|
|
1886
|
+
updatedAt: string;
|
|
1887
|
+
workspaceId: string | null;
|
|
1888
|
+
}[];
|
|
1889
|
+
};
|
|
1890
|
+
PermissionGrantParams: {
|
|
1891
|
+
permissionId: string;
|
|
1892
|
+
};
|
|
1893
|
+
PermissionGrantQuery: {
|
|
1894
|
+
resourceId?: string;
|
|
1895
|
+
resourceType?: string;
|
|
1896
|
+
workspaceId?: string;
|
|
1897
|
+
};
|
|
1898
|
+
PermissionGrantRevoked: {
|
|
1899
|
+
message: string;
|
|
1900
|
+
success: boolean;
|
|
1901
|
+
};
|
|
1902
|
+
PermissionGrantUpdate: {
|
|
1903
|
+
/** Format: date-time */
|
|
1904
|
+
expectedUpdatedAt: string;
|
|
1905
|
+
/** Format: date-time */
|
|
1906
|
+
expiresAt?: string | null;
|
|
1907
|
+
/** @enum {string} */
|
|
1908
|
+
level?: 'read' | 'write' | 'admin';
|
|
1909
|
+
operations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
1910
|
+
};
|
|
1911
|
+
PermissionGrantUpdateParams: {
|
|
1912
|
+
permissionId: string;
|
|
1913
|
+
};
|
|
1914
|
+
PermissionInspection: {
|
|
1915
|
+
application: {
|
|
1916
|
+
access: {
|
|
1917
|
+
/** @enum {string|null} */
|
|
1918
|
+
level: 'read' | 'write' | 'admin' | null;
|
|
1919
|
+
/** @enum {string|null} */
|
|
1920
|
+
restriction: 'identity_policy' | 'resource_scope' | 'no_grant' | null;
|
|
1921
|
+
sources: {
|
|
1922
|
+
grant?: {
|
|
1923
|
+
/** Format: date-time */
|
|
1924
|
+
expiresAt: string | null;
|
|
1925
|
+
id: string;
|
|
1926
|
+
operations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
1927
|
+
principalId: string;
|
|
1928
|
+
principalType: string;
|
|
1929
|
+
resourceId: string;
|
|
1930
|
+
resourceType: string;
|
|
1931
|
+
workspaceId: string | null;
|
|
1932
|
+
};
|
|
1933
|
+
/** @enum {string} */
|
|
1934
|
+
kind: 'owner' | 'creator' | 'organization_member' | 'grant' | 'service';
|
|
1935
|
+
/** @enum {string} */
|
|
1936
|
+
level: 'read' | 'write' | 'admin';
|
|
1937
|
+
}[];
|
|
1938
|
+
};
|
|
1939
|
+
id: string;
|
|
1940
|
+
} | null;
|
|
1941
|
+
/** @enum {string|null} */
|
|
1942
|
+
effectiveLevel: 'read' | 'write' | 'admin' | null;
|
|
1943
|
+
effectiveOperations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
1944
|
+
/** Format: date-time */
|
|
1945
|
+
evaluatedAt: string;
|
|
1946
|
+
principal: {
|
|
1947
|
+
id: string;
|
|
1948
|
+
/** @enum {string} */
|
|
1949
|
+
type: 'user' | 'apiKey' | 'application';
|
|
1950
|
+
};
|
|
1951
|
+
principalAccess: {
|
|
1952
|
+
/** @enum {string|null} */
|
|
1953
|
+
level: 'read' | 'write' | 'admin' | null;
|
|
1954
|
+
/** @enum {string|null} */
|
|
1955
|
+
restriction: 'identity_policy' | 'resource_scope' | 'no_grant' | null;
|
|
1956
|
+
sources: {
|
|
1957
|
+
grant?: {
|
|
1958
|
+
/** Format: date-time */
|
|
1959
|
+
expiresAt: string | null;
|
|
1960
|
+
id: string;
|
|
1961
|
+
operations?: ('application.read_metadata' | 'application.update_metadata' | 'application.read_implementation' | 'application.update_draft' | 'application.publish' | 'application.manage_access' | 'application.manage_hosting' | 'application.delete' | 'business_action.read_metadata' | 'business_action.invoke' | 'business_action.read_implementation' | 'business_action.update_draft' | 'business_action.publish' | 'business_action.manage_access' | 'business_action.delegate_access' | 'business_action.delete')[];
|
|
1962
|
+
principalId: string;
|
|
1963
|
+
principalType: string;
|
|
1964
|
+
resourceId: string;
|
|
1965
|
+
resourceType: string;
|
|
1966
|
+
workspaceId: string | null;
|
|
1967
|
+
};
|
|
1968
|
+
/** @enum {string} */
|
|
1969
|
+
kind: 'owner' | 'creator' | 'organization_member' | 'grant' | 'service';
|
|
1970
|
+
/** @enum {string} */
|
|
1971
|
+
level: 'read' | 'write' | 'admin';
|
|
1972
|
+
}[];
|
|
1973
|
+
};
|
|
1974
|
+
resourceId: string;
|
|
1975
|
+
resourceType: string;
|
|
1976
|
+
restrictions: ('workspace_access_required' | 'key_inactive' | 'key_expired' | 'key_scope')[];
|
|
1977
|
+
workspaceId: string | null;
|
|
1978
|
+
};
|
|
1979
|
+
PermissionInspectionInput: {
|
|
1980
|
+
applicationId?: string;
|
|
1981
|
+
principal: {
|
|
1982
|
+
id: string;
|
|
1983
|
+
/** @enum {string} */
|
|
1984
|
+
type: 'user' | 'apiKey' | 'application';
|
|
1985
|
+
};
|
|
1986
|
+
resourceId: string;
|
|
1987
|
+
};
|
|
1596
1988
|
QueryRequest: {
|
|
1597
1989
|
limit?: number;
|
|
1598
1990
|
sourceIds: string[];
|
|
@@ -8,34 +8,40 @@ 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' | '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';
|
|
11
|
+
export type PublicApiOperationId = 'emailsGet' | 'emailsSend' | 'accessRequestsCreate' | 'accessRequestsList' | 'accessRequestsGet' | 'accessRequestsDecide' | 'permissionsUpdate' | 'permissionsDelete' | 'permissionsList' | 'permissionsCreate' | 'permissionsInspect' | 'connectorSessionsCreate' | 'connectorSessionsGet' | 'resourceRevisionsList' | 'resourceRevisionsGet' | 'resourceRevisionsRestore' | 'resourcesPublish' | 'actionsPublicationRequestsCreate' | 'actionsPublicationRequestsList' | 'actionsPublicationRequestsDecide' | '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' | 'appsPublicationRequestsCreate' | 'appsPublicationRequestsList' | 'appsPublicationRequestsDecide' | '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
|
-
readonly ACUMATICA:
|
|
15
|
-
readonly
|
|
16
|
-
readonly
|
|
17
|
-
readonly
|
|
18
|
-
readonly
|
|
19
|
-
readonly
|
|
20
|
-
readonly
|
|
21
|
-
readonly
|
|
22
|
-
readonly
|
|
23
|
-
readonly
|
|
24
|
-
readonly
|
|
25
|
-
readonly
|
|
26
|
-
readonly
|
|
27
|
-
readonly
|
|
28
|
-
readonly
|
|
29
|
-
readonly
|
|
30
|
-
readonly
|
|
31
|
-
readonly
|
|
32
|
-
readonly
|
|
33
|
-
readonly
|
|
34
|
-
readonly
|
|
35
|
-
readonly
|
|
36
|
-
readonly
|
|
37
|
-
readonly
|
|
38
|
-
readonly
|
|
39
|
-
readonly
|
|
40
|
-
readonly
|
|
14
|
+
readonly ACUMATICA: 'acumatica';
|
|
15
|
+
readonly AMAZON_ADS: 'amazon_ads';
|
|
16
|
+
readonly AMAZON_SELLER_CENTRAL: 'amazon_seller_central';
|
|
17
|
+
readonly ATTIO: 'attio';
|
|
18
|
+
readonly AUTODESK: 'autodesk';
|
|
19
|
+
readonly BIGQUERY: 'bigquery';
|
|
20
|
+
readonly BILLCOM: 'billcom';
|
|
21
|
+
readonly BREX: 'brex';
|
|
22
|
+
readonly DOUBLE: 'double';
|
|
23
|
+
readonly FIREFLIES: 'fireflies';
|
|
24
|
+
readonly GMAIL: 'gmail';
|
|
25
|
+
readonly GOOGLEADS: 'googleads';
|
|
26
|
+
readonly GRANOLA: 'granola';
|
|
27
|
+
readonly HUBSPOT: 'hubspot';
|
|
28
|
+
readonly INSTANTLY: 'instantly';
|
|
29
|
+
readonly KLAVIYO: 'klaviyo';
|
|
30
|
+
readonly MERCURY: 'mercury';
|
|
31
|
+
readonly META_ADS: 'meta_ads';
|
|
32
|
+
readonly MICROSOFT_ADVERTISING: 'microsoft_advertising';
|
|
33
|
+
readonly MONDAY: 'monday';
|
|
34
|
+
readonly PROCORE: 'procore';
|
|
35
|
+
readonly PYLON: 'pylon';
|
|
36
|
+
readonly QUICKBOOKS: 'quickbooks';
|
|
37
|
+
readonly QUO: 'quo';
|
|
38
|
+
readonly S3: 's3';
|
|
39
|
+
readonly SALESFORCE: 'salesforce';
|
|
40
|
+
readonly SHOPIFY: 'shopify';
|
|
41
|
+
readonly STRIPE: 'stripe';
|
|
42
|
+
readonly SUPABASE: 'supabase';
|
|
43
|
+
readonly TIKTOK_ADS: 'tiktok_ads';
|
|
44
|
+
readonly TIKTOK_SHOP: 'tiktok_shop';
|
|
45
|
+
readonly XERO: 'xero';
|
|
46
|
+
readonly YARDI: 'yardi';
|
|
41
47
|
};
|