@farthershore/client 0.6.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/CHANGELOG.md +38 -2
- package/LICENSE +21 -0
- package/README.md +10 -10
- package/dist/index.js +326 -59
- package/dist/types/api.generated.d.ts +105 -25
- package/dist/types/generated/schemas.d.ts +147 -16
- package/dist/types/operations/audit-notifications.d.ts +4 -0
- package/dist/types/operations/auth.d.ts +193 -0
- package/dist/types/operations/backends.d.ts +76 -21
- package/dist/types/operations/businesses.d.ts +48 -0
- package/dist/types/operations/consumers.d.ts +108 -0
- package/dist/types/operations/define.d.ts +1 -1
- package/dist/types/operations/index.d.ts +493 -26
- package/dist/types/operations/organizations.d.ts +7 -0
- package/dist/types/operations/platform.d.ts +6 -6
- package/dist/types/operations/webhooks.d.ts +64 -2
- package/dist/types/surface-types.d.ts +1 -1
- package/dist/types/surface.d.ts +1 -1
- package/dist/types/types.d.ts +20 -6
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
|
@@ -1,5 +1,198 @@
|
|
|
1
1
|
import type { CallerContext } from "../types.js";
|
|
2
2
|
export declare const authOperations: {
|
|
3
|
+
"account.erasure.read": import("./define.js").OperationEntry<void, {
|
|
4
|
+
id: string;
|
|
5
|
+
subjectKind: "builder_account";
|
|
6
|
+
subjectUserId: string;
|
|
7
|
+
requestedBy: "self" | "provider_event";
|
|
8
|
+
status: "pending" | "failed" | "running" | "refused" | "completed";
|
|
9
|
+
stepsCompleted: string[];
|
|
10
|
+
code: string | null;
|
|
11
|
+
createdAt: string;
|
|
12
|
+
updatedAt: string;
|
|
13
|
+
completedAt: string | null;
|
|
14
|
+
} | null, {
|
|
15
|
+
id: string;
|
|
16
|
+
subjectKind: "builder_account";
|
|
17
|
+
subjectUserId: string;
|
|
18
|
+
requestedBy: "self" | "provider_event";
|
|
19
|
+
status: "pending" | "failed" | "running" | "refused" | "completed";
|
|
20
|
+
stepsCompleted: string[];
|
|
21
|
+
code: string | null;
|
|
22
|
+
createdAt: string;
|
|
23
|
+
updatedAt: string;
|
|
24
|
+
completedAt: string | null;
|
|
25
|
+
} | null, false>;
|
|
26
|
+
"personalData.export": import("./define.js").OperationEntry<void, {
|
|
27
|
+
formatVersion: 1;
|
|
28
|
+
generatedAt: string;
|
|
29
|
+
profile: {
|
|
30
|
+
id: string;
|
|
31
|
+
primaryEmail: string | null;
|
|
32
|
+
displayName: string;
|
|
33
|
+
createdAt: string;
|
|
34
|
+
lastSeenAt: string | null;
|
|
35
|
+
};
|
|
36
|
+
organizations: {
|
|
37
|
+
organization: {
|
|
38
|
+
id: string;
|
|
39
|
+
name: string;
|
|
40
|
+
slug: string;
|
|
41
|
+
deletedAt: string | null;
|
|
42
|
+
};
|
|
43
|
+
role: {
|
|
44
|
+
key: string;
|
|
45
|
+
name: string;
|
|
46
|
+
};
|
|
47
|
+
createdAt: string;
|
|
48
|
+
}[];
|
|
49
|
+
legalAcceptances: {
|
|
50
|
+
document: string;
|
|
51
|
+
version: string;
|
|
52
|
+
acceptedAt: string;
|
|
53
|
+
source: string;
|
|
54
|
+
}[];
|
|
55
|
+
notificationPreferences: {
|
|
56
|
+
businessId: string | null;
|
|
57
|
+
recipientOrganizationId: string | null;
|
|
58
|
+
emailOptOut: boolean;
|
|
59
|
+
categoryOptOuts: Record<string, boolean> | null;
|
|
60
|
+
}[];
|
|
61
|
+
credentials: {
|
|
62
|
+
apps: {
|
|
63
|
+
id: string;
|
|
64
|
+
name: string;
|
|
65
|
+
clientKind: string;
|
|
66
|
+
scopes: string[];
|
|
67
|
+
organizationId: string | null;
|
|
68
|
+
createdAt: string;
|
|
69
|
+
lastUsedAt: string | null;
|
|
70
|
+
revokedAt: string | null;
|
|
71
|
+
}[];
|
|
72
|
+
api: {
|
|
73
|
+
id: string;
|
|
74
|
+
name: string;
|
|
75
|
+
organizationId: string;
|
|
76
|
+
grantedPermissions: string[];
|
|
77
|
+
businessScopeMode: string;
|
|
78
|
+
createdAt: string;
|
|
79
|
+
lastUsedAt: string | null;
|
|
80
|
+
revokedAt: string | null;
|
|
81
|
+
}[];
|
|
82
|
+
};
|
|
83
|
+
recentAudit: {
|
|
84
|
+
limit: number;
|
|
85
|
+
hasMore: boolean;
|
|
86
|
+
entries: {
|
|
87
|
+
id: string;
|
|
88
|
+
action: string;
|
|
89
|
+
createdAt: string;
|
|
90
|
+
}[];
|
|
91
|
+
};
|
|
92
|
+
}, {
|
|
93
|
+
formatVersion: 1;
|
|
94
|
+
generatedAt: string;
|
|
95
|
+
profile: {
|
|
96
|
+
id: string;
|
|
97
|
+
primaryEmail: string | null;
|
|
98
|
+
displayName: string;
|
|
99
|
+
createdAt: string;
|
|
100
|
+
lastSeenAt: string | null;
|
|
101
|
+
};
|
|
102
|
+
organizations: {
|
|
103
|
+
organization: {
|
|
104
|
+
id: string;
|
|
105
|
+
name: string;
|
|
106
|
+
slug: string;
|
|
107
|
+
deletedAt: string | null;
|
|
108
|
+
};
|
|
109
|
+
role: {
|
|
110
|
+
key: string;
|
|
111
|
+
name: string;
|
|
112
|
+
};
|
|
113
|
+
createdAt: string;
|
|
114
|
+
}[];
|
|
115
|
+
legalAcceptances: {
|
|
116
|
+
document: string;
|
|
117
|
+
version: string;
|
|
118
|
+
acceptedAt: string;
|
|
119
|
+
source: string;
|
|
120
|
+
}[];
|
|
121
|
+
notificationPreferences: {
|
|
122
|
+
businessId: string | null;
|
|
123
|
+
recipientOrganizationId: string | null;
|
|
124
|
+
emailOptOut: boolean;
|
|
125
|
+
categoryOptOuts: Record<string, boolean> | null;
|
|
126
|
+
}[];
|
|
127
|
+
credentials: {
|
|
128
|
+
apps: {
|
|
129
|
+
id: string;
|
|
130
|
+
name: string;
|
|
131
|
+
clientKind: string;
|
|
132
|
+
scopes: string[];
|
|
133
|
+
organizationId: string | null;
|
|
134
|
+
createdAt: string;
|
|
135
|
+
lastUsedAt: string | null;
|
|
136
|
+
revokedAt: string | null;
|
|
137
|
+
}[];
|
|
138
|
+
api: {
|
|
139
|
+
id: string;
|
|
140
|
+
name: string;
|
|
141
|
+
organizationId: string;
|
|
142
|
+
grantedPermissions: string[];
|
|
143
|
+
businessScopeMode: string;
|
|
144
|
+
createdAt: string;
|
|
145
|
+
lastUsedAt: string | null;
|
|
146
|
+
revokedAt: string | null;
|
|
147
|
+
}[];
|
|
148
|
+
};
|
|
149
|
+
recentAudit: {
|
|
150
|
+
limit: number;
|
|
151
|
+
hasMore: boolean;
|
|
152
|
+
entries: {
|
|
153
|
+
id: string;
|
|
154
|
+
action: string;
|
|
155
|
+
createdAt: string;
|
|
156
|
+
}[];
|
|
157
|
+
};
|
|
158
|
+
}, false>;
|
|
159
|
+
"platform.legal.read": import("./define.js").OperationEntry<void, {
|
|
160
|
+
accepted: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
161
|
+
outstanding: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
162
|
+
requiredVersions: {
|
|
163
|
+
terms: string;
|
|
164
|
+
privacy: string;
|
|
165
|
+
"acceptable-use": string;
|
|
166
|
+
"builder-agreement": string;
|
|
167
|
+
};
|
|
168
|
+
upcoming: {
|
|
169
|
+
document: "terms" | "privacy" | "acceptable-use" | "builder-agreement";
|
|
170
|
+
version: string;
|
|
171
|
+
effectiveOn: string;
|
|
172
|
+
changeClass: "routine" | "material";
|
|
173
|
+
summary: string;
|
|
174
|
+
accepted: boolean;
|
|
175
|
+
}[];
|
|
176
|
+
dashboardUrl: string;
|
|
177
|
+
}, {
|
|
178
|
+
accepted: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
179
|
+
outstanding: ("terms" | "privacy" | "acceptable-use" | "builder-agreement")[];
|
|
180
|
+
requiredVersions: {
|
|
181
|
+
terms: string;
|
|
182
|
+
privacy: string;
|
|
183
|
+
"acceptable-use": string;
|
|
184
|
+
"builder-agreement": string;
|
|
185
|
+
};
|
|
186
|
+
upcoming: {
|
|
187
|
+
document: "terms" | "privacy" | "acceptable-use" | "builder-agreement";
|
|
188
|
+
version: string;
|
|
189
|
+
effectiveOn: string;
|
|
190
|
+
changeClass: "routine" | "material";
|
|
191
|
+
summary: string;
|
|
192
|
+
accepted: boolean;
|
|
193
|
+
}[];
|
|
194
|
+
dashboardUrl: string;
|
|
195
|
+
}, false>;
|
|
3
196
|
"auth.context.read": import("./define.js").OperationEntry<void, CallerContext, CallerContext, false>;
|
|
4
197
|
"auth.context.issue": import("./define.js").OperationEntry<{
|
|
5
198
|
businessId: string;
|
|
@@ -2,7 +2,7 @@ type BusinessRef = {
|
|
|
2
2
|
businessId: string;
|
|
3
3
|
};
|
|
4
4
|
/**
|
|
5
|
-
* Backends and
|
|
5
|
+
* Backends and secret keys are per-(business, environment) rows.
|
|
6
6
|
* `environmentId` filters a listing: an environment id, `"production"` for the
|
|
7
7
|
* production rows, or omitted for every scope.
|
|
8
8
|
*/
|
|
@@ -36,16 +36,24 @@ export declare const backendOperations: {
|
|
|
36
36
|
"backends.create": import("./define.js").OperationEntry<BusinessRef & {
|
|
37
37
|
name: string;
|
|
38
38
|
slug?: string;
|
|
39
|
-
/**
|
|
39
|
+
/**
|
|
40
|
+
* The environments this deployment serves: all | production |
|
|
41
|
+
* non-production | kind:<kind> | env:<environment>. Default all.
|
|
42
|
+
*/
|
|
43
|
+
scope?: string;
|
|
44
|
+
/** One environment directly (= scope env:<environment>). */
|
|
40
45
|
environmentId?: string | null;
|
|
41
46
|
transportMode?: "direct" | "tunnel";
|
|
42
47
|
runner?: "embedded" | "sidecar" | null;
|
|
43
48
|
runtime?: string | null;
|
|
44
49
|
originUrl?: string | null;
|
|
50
|
+
/** Per-environment origin (`{env}`) of a non-production / kind: deployment. */
|
|
51
|
+
originTemplate?: string | null;
|
|
45
52
|
isDefault?: boolean;
|
|
46
53
|
}, {
|
|
47
54
|
id: string;
|
|
48
55
|
businessId: string;
|
|
56
|
+
scope: string;
|
|
49
57
|
environmentId: string | null;
|
|
50
58
|
name: string;
|
|
51
59
|
slug: string;
|
|
@@ -53,15 +61,24 @@ export declare const backendOperations: {
|
|
|
53
61
|
runner: ("embedded" | "sidecar") | null;
|
|
54
62
|
runtime: string | null;
|
|
55
63
|
originUrl: string | null;
|
|
64
|
+
originTemplate: string | null;
|
|
56
65
|
isDefault: boolean;
|
|
57
66
|
status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
|
|
58
67
|
lastSeenAt: string | null;
|
|
59
68
|
createdAt: string;
|
|
60
69
|
updated?: true;
|
|
70
|
+
webhookReceiver?: "created" | "kept" | "skipped_at_limit" | "none";
|
|
71
|
+
defaultKey?: {
|
|
72
|
+
id: string;
|
|
73
|
+
lastFour: string;
|
|
74
|
+
envVars: ["FS_SECRET_KEY"];
|
|
75
|
+
token: string;
|
|
76
|
+
};
|
|
61
77
|
}, {
|
|
62
78
|
action: "create" | "update";
|
|
63
79
|
backend: {
|
|
64
80
|
businessId: string;
|
|
81
|
+
scope: string;
|
|
65
82
|
environmentId: string | null;
|
|
66
83
|
name: string;
|
|
67
84
|
slug: string;
|
|
@@ -69,17 +86,30 @@ export declare const backendOperations: {
|
|
|
69
86
|
runner: ("embedded" | "sidecar") | null;
|
|
70
87
|
runtime: string | null;
|
|
71
88
|
originUrl: string | null;
|
|
89
|
+
originTemplate: string | null;
|
|
72
90
|
isDefault: boolean;
|
|
73
91
|
};
|
|
74
92
|
}, true>;
|
|
75
|
-
"backends.bind": import("./define.js").OperationEntry<BusinessRef & {
|
|
76
|
-
/** The
|
|
93
|
+
"backends.bind": import("./define.js").OperationEntry<BusinessRef & ({
|
|
94
|
+
/** The backend slug, or one deployment's id. */
|
|
77
95
|
backend: string;
|
|
96
|
+
/**
|
|
97
|
+
* Which deployment: all (default for a fixed origin) | production |
|
|
98
|
+
* non-production (default for a template) | kind:<kind> |
|
|
99
|
+
* env:<environment>. Created when the backend has none of that scope.
|
|
100
|
+
*/
|
|
101
|
+
scope?: string;
|
|
78
102
|
environmentId?: string | null;
|
|
103
|
+
} & ({
|
|
79
104
|
originUrl: string;
|
|
80
|
-
|
|
105
|
+
originTemplate?: never;
|
|
106
|
+
} | {
|
|
107
|
+
originTemplate: string;
|
|
108
|
+
originUrl?: never;
|
|
109
|
+
})), {
|
|
81
110
|
id: string;
|
|
82
111
|
businessId: string;
|
|
112
|
+
scope: string;
|
|
83
113
|
environmentId: string | null;
|
|
84
114
|
name: string;
|
|
85
115
|
slug: string;
|
|
@@ -87,13 +117,22 @@ export declare const backendOperations: {
|
|
|
87
117
|
runner: ("embedded" | "sidecar") | null;
|
|
88
118
|
runtime: string | null;
|
|
89
119
|
originUrl: string | null;
|
|
120
|
+
originTemplate: string | null;
|
|
90
121
|
isDefault: boolean;
|
|
91
122
|
status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
|
|
92
123
|
lastSeenAt: string | null;
|
|
93
124
|
createdAt: string;
|
|
125
|
+
webhookReceiver?: "created" | "kept" | "skipped_at_limit" | "none";
|
|
126
|
+
defaultKey?: {
|
|
127
|
+
id: string;
|
|
128
|
+
lastFour: string;
|
|
129
|
+
envVars: ["FS_SECRET_KEY"];
|
|
130
|
+
token: string;
|
|
131
|
+
};
|
|
94
132
|
}, {
|
|
95
133
|
id: string;
|
|
96
134
|
businessId: string;
|
|
135
|
+
scope: string;
|
|
97
136
|
environmentId: string | null;
|
|
98
137
|
name: string;
|
|
99
138
|
slug: string;
|
|
@@ -101,6 +140,7 @@ export declare const backendOperations: {
|
|
|
101
140
|
runner: ("embedded" | "sidecar") | null;
|
|
102
141
|
runtime: string | null;
|
|
103
142
|
originUrl: string | null;
|
|
143
|
+
originTemplate: string | null;
|
|
104
144
|
isDefault: boolean;
|
|
105
145
|
status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
|
|
106
146
|
lastSeenAt: string | null;
|
|
@@ -115,8 +155,8 @@ export declare const backendOperations: {
|
|
|
115
155
|
id: string;
|
|
116
156
|
deleted: true;
|
|
117
157
|
}, false>;
|
|
118
|
-
"
|
|
119
|
-
data: import("../generated/schemas.js").components["schemas"]["
|
|
158
|
+
"secretKeys.read": import("./define.js").OperationEntry<ScopeFilter, {
|
|
159
|
+
data: import("../generated/schemas.js").components["schemas"]["SecretKey"][];
|
|
120
160
|
pagination: {
|
|
121
161
|
total: number;
|
|
122
162
|
limit: number;
|
|
@@ -126,7 +166,7 @@ export declare const backendOperations: {
|
|
|
126
166
|
scope: "all" | "production" | "environment";
|
|
127
167
|
environmentId: string | null;
|
|
128
168
|
}, {
|
|
129
|
-
data: import("../generated/schemas.js").components["schemas"]["
|
|
169
|
+
data: import("../generated/schemas.js").components["schemas"]["SecretKey"][];
|
|
130
170
|
pagination: {
|
|
131
171
|
total: number;
|
|
132
172
|
limit: number;
|
|
@@ -136,7 +176,10 @@ export declare const backendOperations: {
|
|
|
136
176
|
scope: "all" | "production" | "environment";
|
|
137
177
|
environmentId: string | null;
|
|
138
178
|
}, false>;
|
|
139
|
-
"
|
|
179
|
+
"secretKeys.mint": import("./define.js").OperationEntry<BusinessRef & {
|
|
180
|
+
/** The environments the key may act for. Default all. */
|
|
181
|
+
scope?: string;
|
|
182
|
+
/** One environment directly (= scope env:<environment>). */
|
|
140
183
|
environmentId?: string | null;
|
|
141
184
|
backendId?: string | null;
|
|
142
185
|
kind?: "live" | "test";
|
|
@@ -146,11 +189,13 @@ export declare const backendOperations: {
|
|
|
146
189
|
}, {
|
|
147
190
|
id: string;
|
|
148
191
|
businessId: string;
|
|
192
|
+
scope: string;
|
|
149
193
|
environmentId: string | null;
|
|
150
194
|
backendId: string | null;
|
|
195
|
+
isDefault: boolean;
|
|
151
196
|
kind: "live" | "test";
|
|
152
197
|
lastFour: string;
|
|
153
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
198
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
154
199
|
allowedMeters: string[];
|
|
155
200
|
allowedRoutes: string[];
|
|
156
201
|
status: "active" | "revoked";
|
|
@@ -158,16 +203,18 @@ export declare const backendOperations: {
|
|
|
158
203
|
createdAt: string;
|
|
159
204
|
revokedAt: string | null;
|
|
160
205
|
lastUsedAt: string | null;
|
|
161
|
-
envVar: "
|
|
206
|
+
envVar: "FS_SECRET_KEY";
|
|
162
207
|
token: string;
|
|
163
208
|
}, {
|
|
164
209
|
id: string;
|
|
165
210
|
businessId: string;
|
|
211
|
+
scope: string;
|
|
166
212
|
environmentId: string | null;
|
|
167
213
|
backendId: string | null;
|
|
214
|
+
isDefault: boolean;
|
|
168
215
|
kind: "live" | "test";
|
|
169
216
|
lastFour: string;
|
|
170
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
217
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
171
218
|
allowedMeters: string[];
|
|
172
219
|
allowedRoutes: string[];
|
|
173
220
|
status: "active" | "revoked";
|
|
@@ -175,19 +222,21 @@ export declare const backendOperations: {
|
|
|
175
222
|
createdAt: string;
|
|
176
223
|
revokedAt: string | null;
|
|
177
224
|
lastUsedAt: string | null;
|
|
178
|
-
envVar: "
|
|
225
|
+
envVar: "FS_SECRET_KEY";
|
|
179
226
|
token: string;
|
|
180
227
|
}, false>;
|
|
181
|
-
"
|
|
228
|
+
"secretKeys.rotate": import("./define.js").OperationEntry<BusinessRef & {
|
|
182
229
|
tokenId: string;
|
|
183
230
|
}, {
|
|
184
231
|
id: string;
|
|
185
232
|
businessId: string;
|
|
233
|
+
scope: string;
|
|
186
234
|
environmentId: string | null;
|
|
187
235
|
backendId: string | null;
|
|
236
|
+
isDefault: boolean;
|
|
188
237
|
kind: "live" | "test";
|
|
189
238
|
lastFour: string;
|
|
190
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
239
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
191
240
|
allowedMeters: string[];
|
|
192
241
|
allowedRoutes: string[];
|
|
193
242
|
status: "active" | "revoked";
|
|
@@ -195,16 +244,18 @@ export declare const backendOperations: {
|
|
|
195
244
|
createdAt: string;
|
|
196
245
|
revokedAt: string | null;
|
|
197
246
|
lastUsedAt: string | null;
|
|
198
|
-
envVar: "
|
|
247
|
+
envVar: "FS_SECRET_KEY";
|
|
199
248
|
token: string;
|
|
200
249
|
}, {
|
|
201
250
|
id: string;
|
|
202
251
|
businessId: string;
|
|
252
|
+
scope: string;
|
|
203
253
|
environmentId: string | null;
|
|
204
254
|
backendId: string | null;
|
|
255
|
+
isDefault: boolean;
|
|
205
256
|
kind: "live" | "test";
|
|
206
257
|
lastFour: string;
|
|
207
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
258
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
208
259
|
allowedMeters: string[];
|
|
209
260
|
allowedRoutes: string[];
|
|
210
261
|
status: "active" | "revoked";
|
|
@@ -212,19 +263,21 @@ export declare const backendOperations: {
|
|
|
212
263
|
createdAt: string;
|
|
213
264
|
revokedAt: string | null;
|
|
214
265
|
lastUsedAt: string | null;
|
|
215
|
-
envVar: "
|
|
266
|
+
envVar: "FS_SECRET_KEY";
|
|
216
267
|
token: string;
|
|
217
268
|
}, false>;
|
|
218
|
-
"
|
|
269
|
+
"secretKeys.revoke": import("./define.js").OperationEntry<BusinessRef & {
|
|
219
270
|
tokenId: string;
|
|
220
271
|
}, {
|
|
221
272
|
id: string;
|
|
222
273
|
businessId: string;
|
|
274
|
+
scope: string;
|
|
223
275
|
environmentId: string | null;
|
|
224
276
|
backendId: string | null;
|
|
277
|
+
isDefault: boolean;
|
|
225
278
|
kind: "live" | "test";
|
|
226
279
|
lastFour: string;
|
|
227
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
280
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
228
281
|
allowedMeters: string[];
|
|
229
282
|
allowedRoutes: string[];
|
|
230
283
|
status: "active" | "revoked";
|
|
@@ -235,11 +288,13 @@ export declare const backendOperations: {
|
|
|
235
288
|
}, {
|
|
236
289
|
id: string;
|
|
237
290
|
businessId: string;
|
|
291
|
+
scope: string;
|
|
238
292
|
environmentId: string | null;
|
|
239
293
|
backendId: string | null;
|
|
294
|
+
isDefault: boolean;
|
|
240
295
|
kind: "live" | "test";
|
|
241
296
|
lastFour: string;
|
|
242
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
297
|
+
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report" | "webhook_secrets")[];
|
|
243
298
|
allowedMeters: string[];
|
|
244
299
|
allowedRoutes: string[];
|
|
245
300
|
status: "active" | "revoked";
|
|
@@ -112,6 +112,15 @@ export declare const businessOperations: {
|
|
|
112
112
|
[key: string]: string;
|
|
113
113
|
};
|
|
114
114
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
115
|
+
launchRequirements: {
|
|
116
|
+
obligation: "account.agreements_accepted" | "seller.details_complete";
|
|
117
|
+
summary: string;
|
|
118
|
+
missing: string[];
|
|
119
|
+
fix: {
|
|
120
|
+
label: string;
|
|
121
|
+
url: string;
|
|
122
|
+
};
|
|
123
|
+
}[];
|
|
115
124
|
}, {
|
|
116
125
|
id: string;
|
|
117
126
|
organizationId: string | null;
|
|
@@ -146,6 +155,15 @@ export declare const businessOperations: {
|
|
|
146
155
|
[key: string]: string;
|
|
147
156
|
};
|
|
148
157
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
158
|
+
launchRequirements: {
|
|
159
|
+
obligation: "account.agreements_accepted" | "seller.details_complete";
|
|
160
|
+
summary: string;
|
|
161
|
+
missing: string[];
|
|
162
|
+
fix: {
|
|
163
|
+
label: string;
|
|
164
|
+
url: string;
|
|
165
|
+
};
|
|
166
|
+
}[];
|
|
149
167
|
}, false>;
|
|
150
168
|
"businesses.create": import("./define.js").OperationEntry<{
|
|
151
169
|
name: string;
|
|
@@ -163,6 +181,12 @@ export declare const businessOperations: {
|
|
|
163
181
|
instructions: string;
|
|
164
182
|
agentsMdUrl: string;
|
|
165
183
|
};
|
|
184
|
+
defaultKey?: {
|
|
185
|
+
id: string;
|
|
186
|
+
lastFour: string;
|
|
187
|
+
envVars: ["FS_SECRET_KEY"];
|
|
188
|
+
token: string;
|
|
189
|
+
};
|
|
166
190
|
}, {
|
|
167
191
|
business: import("../generated/schemas.js").components["schemas"]["Business"];
|
|
168
192
|
repo: {
|
|
@@ -174,6 +198,12 @@ export declare const businessOperations: {
|
|
|
174
198
|
instructions: string;
|
|
175
199
|
agentsMdUrl: string;
|
|
176
200
|
};
|
|
201
|
+
defaultKey?: {
|
|
202
|
+
id: string;
|
|
203
|
+
lastFour: string;
|
|
204
|
+
envVars: ["FS_SECRET_KEY"];
|
|
205
|
+
token: string;
|
|
206
|
+
};
|
|
177
207
|
}, false>;
|
|
178
208
|
"businesses.routes.read": import("./define.js").OperationEntry<EnvScoped, {
|
|
179
209
|
routes: import("../generated/schemas.js").components["schemas"]["BusinessRoute"][];
|
|
@@ -754,6 +784,15 @@ export declare const businessOperations: {
|
|
|
754
784
|
[key: string]: string;
|
|
755
785
|
};
|
|
756
786
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
787
|
+
launchRequirements: {
|
|
788
|
+
obligation: "account.agreements_accepted" | "seller.details_complete";
|
|
789
|
+
summary: string;
|
|
790
|
+
missing: string[];
|
|
791
|
+
fix: {
|
|
792
|
+
label: string;
|
|
793
|
+
url: string;
|
|
794
|
+
};
|
|
795
|
+
}[];
|
|
757
796
|
}, {
|
|
758
797
|
id: string;
|
|
759
798
|
organizationId: string | null;
|
|
@@ -788,6 +827,15 @@ export declare const businessOperations: {
|
|
|
788
827
|
[key: string]: string;
|
|
789
828
|
};
|
|
790
829
|
environments: import("../generated/schemas.js").components["schemas"]["BusinessEnvironment"][];
|
|
830
|
+
launchRequirements: {
|
|
831
|
+
obligation: "account.agreements_accepted" | "seller.details_complete";
|
|
832
|
+
summary: string;
|
|
833
|
+
missing: string[];
|
|
834
|
+
fix: {
|
|
835
|
+
label: string;
|
|
836
|
+
url: string;
|
|
837
|
+
};
|
|
838
|
+
}[];
|
|
791
839
|
}, false>;
|
|
792
840
|
"businesses.rbac.enable": import("./define.js").OperationEntry<BusinessRef, {
|
|
793
841
|
rbacEnabled: boolean;
|
|
@@ -6,6 +6,114 @@ type RoleRef = SubscriberRef & {
|
|
|
6
6
|
roleKey: string;
|
|
7
7
|
};
|
|
8
8
|
export declare const consumerOperations: {
|
|
9
|
+
"consumers.data.export": import("./define.js").OperationEntry<SubscriberRef, {
|
|
10
|
+
formatVersion: 1;
|
|
11
|
+
generatedAt: string;
|
|
12
|
+
businessId: string;
|
|
13
|
+
truncated: boolean;
|
|
14
|
+
profile: {
|
|
15
|
+
id: string;
|
|
16
|
+
kind: string;
|
|
17
|
+
name: string | null;
|
|
18
|
+
email: string | null;
|
|
19
|
+
createdAt: string;
|
|
20
|
+
};
|
|
21
|
+
subscriptions: {
|
|
22
|
+
id: string;
|
|
23
|
+
status: string;
|
|
24
|
+
compiledPlanId: string | null;
|
|
25
|
+
}[];
|
|
26
|
+
apiKeys: {
|
|
27
|
+
name: string | null;
|
|
28
|
+
createdAt: string;
|
|
29
|
+
lastUsedAt: string | null;
|
|
30
|
+
}[];
|
|
31
|
+
legalAcceptances: {
|
|
32
|
+
ref: string;
|
|
33
|
+
version: string;
|
|
34
|
+
acceptedAt: string;
|
|
35
|
+
}[];
|
|
36
|
+
notificationPreferences: {
|
|
37
|
+
recipientId: string;
|
|
38
|
+
emailOptOut: boolean;
|
|
39
|
+
categoryOptOuts: Record<string, boolean> | null;
|
|
40
|
+
}[];
|
|
41
|
+
marketingEnabled: boolean;
|
|
42
|
+
membership: {
|
|
43
|
+
email: string | null;
|
|
44
|
+
role: string;
|
|
45
|
+
createdAt: string;
|
|
46
|
+
} | null;
|
|
47
|
+
}, {
|
|
48
|
+
formatVersion: 1;
|
|
49
|
+
generatedAt: string;
|
|
50
|
+
businessId: string;
|
|
51
|
+
truncated: boolean;
|
|
52
|
+
profile: {
|
|
53
|
+
id: string;
|
|
54
|
+
kind: string;
|
|
55
|
+
name: string | null;
|
|
56
|
+
email: string | null;
|
|
57
|
+
createdAt: string;
|
|
58
|
+
};
|
|
59
|
+
subscriptions: {
|
|
60
|
+
id: string;
|
|
61
|
+
status: string;
|
|
62
|
+
compiledPlanId: string | null;
|
|
63
|
+
}[];
|
|
64
|
+
apiKeys: {
|
|
65
|
+
name: string | null;
|
|
66
|
+
createdAt: string;
|
|
67
|
+
lastUsedAt: string | null;
|
|
68
|
+
}[];
|
|
69
|
+
legalAcceptances: {
|
|
70
|
+
ref: string;
|
|
71
|
+
version: string;
|
|
72
|
+
acceptedAt: string;
|
|
73
|
+
}[];
|
|
74
|
+
notificationPreferences: {
|
|
75
|
+
recipientId: string;
|
|
76
|
+
emailOptOut: boolean;
|
|
77
|
+
categoryOptOuts: Record<string, boolean> | null;
|
|
78
|
+
}[];
|
|
79
|
+
marketingEnabled: boolean;
|
|
80
|
+
membership: {
|
|
81
|
+
email: string | null;
|
|
82
|
+
role: string;
|
|
83
|
+
createdAt: string;
|
|
84
|
+
} | null;
|
|
85
|
+
}, false>;
|
|
86
|
+
"consumers.data.erasure.read": import("./define.js").OperationEntry<SubscriberRef, {
|
|
87
|
+
id: string;
|
|
88
|
+
subjectKind: "customer_for_business";
|
|
89
|
+
subjectUserId: null;
|
|
90
|
+
customerScopeKey: string;
|
|
91
|
+
subjectBusinessId: string;
|
|
92
|
+
subjectSubscriberId: string;
|
|
93
|
+
subjectPersonId: string | null;
|
|
94
|
+
requestedBy: "builder" | "self";
|
|
95
|
+
status: "pending" | "failed" | "running" | "refused" | "completed";
|
|
96
|
+
stepsCompleted: string[];
|
|
97
|
+
code: string | null;
|
|
98
|
+
createdAt: string;
|
|
99
|
+
updatedAt: string;
|
|
100
|
+
completedAt: string | null;
|
|
101
|
+
} | null, {
|
|
102
|
+
id: string;
|
|
103
|
+
subjectKind: "customer_for_business";
|
|
104
|
+
subjectUserId: null;
|
|
105
|
+
customerScopeKey: string;
|
|
106
|
+
subjectBusinessId: string;
|
|
107
|
+
subjectSubscriberId: string;
|
|
108
|
+
subjectPersonId: string | null;
|
|
109
|
+
requestedBy: "builder" | "self";
|
|
110
|
+
status: "pending" | "failed" | "running" | "refused" | "completed";
|
|
111
|
+
stepsCompleted: string[];
|
|
112
|
+
code: string | null;
|
|
113
|
+
createdAt: string;
|
|
114
|
+
updatedAt: string;
|
|
115
|
+
completedAt: string | null;
|
|
116
|
+
} | null, false>;
|
|
9
117
|
"consumers.read": import("./define.js").OperationEntry<{
|
|
10
118
|
businessId: string;
|
|
11
119
|
env?: string;
|
|
@@ -74,7 +74,7 @@ export type OutputOf<E> = E extends OperationEntry<never, infer O, any> ? O : ne
|
|
|
74
74
|
/**
|
|
75
75
|
* Encode one caller-supplied value without letting it alter the path shape.
|
|
76
76
|
* `encodeURIComponent` leaves `.` and `..` intact, and URL normalization would
|
|
77
|
-
* resolve them against the route (`/businesses/b/
|
|
77
|
+
* resolve them against the route (`/businesses/b/secret-keys/..` is
|
|
78
78
|
* `/businesses/b/`), so those, empty values and non-strings are refused: the
|
|
79
79
|
* request a value builds must be the route the operation names.
|
|
80
80
|
*/
|